# Documentación del Proyecto: Explicador de Código

## 1. Descripción del Proyecto
Este proyecto consiste en un aplicativo web desarrollado con **Streamlit** y **Python** que permite recibir un fragmento de código en cualquier lenguaje de programación y generar una explicación detallada sobre su funcionamiento. Utiliza **OpenAI GPT-4** para analizar y describir el código ingresado.

## 2. Requisitos
Para ejecutar este proyecto, es necesario instalar las siguientes dependencias:

### **2.1 Instalación de dependencias**
Crea un archivo `requirements.txt` con el siguiente contenido:

```
streamlit
openai
langdetect
```

Luego, instala las dependencias ejecutando:

```sh
pip install -r requirements.txt
```

## 3. Uso del Aplicativo
1. Ejecuta el siguiente comando en la terminal para iniciar la aplicación:

   ```sh
   streamlit run app.py
   ```

2. Se abrirá una interfaz en el navegador donde podrás pegar un fragmento de código en el campo de texto.
3. Haz clic en **"Explicar código"** y el sistema generará una descripción detallada del código ingresado.

## 4. Configuración de la API de OpenAI
Para que el modelo de lenguaje funcione correctamente, necesitas una clave de API de OpenAI.

1. Regístrate en [OpenAI](https://openai.com/).
2. Obtén una clave de API desde la sección de configuraciones de tu cuenta.
3. En el archivo `app.py`, reemplaza `tu_clave_aqui` por tu clave de API.

## 5. Publicación en Hugging Face Spaces
Para subir este proyecto a **Hugging Face Spaces**, sigue estos pasos:

1. Crea una cuenta en [Hugging Face](https://huggingface.co/).
2. Dirígete a la sección **Spaces** y crea un nuevo espacio.
3. Selecciona **Streamlit** como framework.
4. Sube los archivos del proyecto (`app.py`, `requirements.txt`).
5. Espera a que se despliegue automáticamente.
6. Comparte el enlace generado para que otros puedan acceder al aplicativo.

## 6. Entrega Final
El proyecto deberá incluir:
- Código fuente en Python (`app.py`).
- Archivo `requirements.txt` con las dependencias.
- Documentación detallada (este archivo).
- Presentación de la aplicación.
- Enlace a la aplicación desplegada en **Hugging Face Spaces**.

## 7. Contacto y Soporte
Para cualquier duda o mejora del proyecto, puedes abrir un **issue** en el repositorio de GitHub o contactar a través de Hugging Face Spaces.