update intructions

Author: rosinni

.devcontainer/Dockerfile

@@ -1,4 +1,4 @@
-FROM mcr.microsoft.com/devcontainers/python:0-3.10
+FROM mcr.microsoft.com/devcontainers/python:0-3.11
 
 ENV PYTHONUNBUFFERED 1
 

.env.example

@@ -1 +1 @@
-DATABASE_URL=postgresql://gitpod@localhost:5432/example
+DATABASE_URL=postgresql://gitpod@localhost:5432/sample-db

README.es.md

@@ -6,17 +6,28 @@ Esta plantilla está diseñada para impulsar proyectos de ciencia de datos propo
 
 El proyecto está organizado de la siguiente manera:
 
-- `app.py` - El script principal de Python que ejecutas para tu proyecto.
-- `explore.py` - Un notebook para que puedas hacer tus exploraciones, idealmente el codigo de este notebook se migra hacia app.py para subir a produccion.
-- `utils.py` - Este archivo contiene código de utilidad para operaciones como conexiones de base de datos.
-- `requirements.txt` - Este archivo contiene la lista de paquetes de Python necesarios.
-- `models/` - Este directorio debería contener tus clases de modelos SQLAlchemy.
-- `data/` - Este directorio contiene los siguientes subdirectorios:
-  - `interim/` - Para datos intermedios que han sido transformados.
-  - `processed/` - Para los datos finales a utilizar para el modelado.
-  - `raw/` - Para datos brutos sin ningún procesamiento.
-
-## Configuración
+- **`src/app.py`** → Script principal de Python donde correrá tu proyecto.
+- **`src/explore.ipynb`** → Notebook para exploración y pruebas. Una vez finalizada la exploración, migra el código limpio a `app.py`.
+- **`src/utils.py`** → Funciones auxiliares, como conexión a bases de datos.
+- **`requirements.txt`** → Lista de paquetes de Python necesarios.
+- **`models/`** → Contendrá tus clases de modelos SQLAlchemy.
+- **`data/`** → Almacena los datasets en diferentes etapas:
+  - **`data/raw/`** → Datos sin procesar.
+  - **`data/interim/`** → Datos transformados temporalmente.
+  - **`data/processed/`** → Datos listos para análisis.
+
+
+## ⚡ Configuración Inicial en Codespaces (Recomendado)
+
+No es necesario realizar ninguna configuración manual, ya que **Codespaces se configura automáticamente** con los archivos predefinidos que ha creado la academia para ti. Simplemente sigue estos pasos:
+
+1. **Espera a que el entorno se configure automáticamente**.
+   - Todos los paquetes necesarios y la base de datos se instalarán por sí mismos.
+   - El `username` y `db_name` creados automáticamente están en el archivo **`.env`** en la raíz del proyecto.
+2. **Una vez que Codespaces esté listo, puedes comenzar a trabajar inmediatamente**.
+
+
+## 💻 Configuración en Local (Solo si no puedes usar Codespaces)
 
 **Prerrequisitos**
 
@@ -34,9 +45,19 @@ pip install -r requirements.txt
 
 **Crear una base de datos (si es necesario)**
 
-Crea una nueva base de datos dentro del motor Postgres personalizando y ejecutando el siguiente comando: `$ createdb -h localhost -U <username> <db_name>`
-Conéctate al motor Postgres para usar tu base de datos, manipular tablas y datos: `$ psql -h localhost -U <username> <db_name>`
-NOTA: Recuerda revisar la información del archivo ./.env para obtener el nombre de usuario y db_name.
+Crea una nueva base de datos dentro del motor Postgres personalizando y ejecutando el siguiente comando: 
+
+```bash
+$ psql -U postgres -c "DO \$\$ BEGIN 
+    CREATE USER mi_usuario WITH PASSWORD 'mi_contraseña'; 
+    CREATE DATABASE mi_base_de_datos OWNER mi_usuario; 
+END \$\$;"
+```
+Conéctate al motor Postgres para usar tu base de datos, manipular tablas y datos: 
+
+```bash
+$ psql -U mi_usuario -d mi_base_de_datos
+```
 
 ¡Una vez que estés dentro de PSQL podrás crear tablas, hacer consultas, insertar, actualizar o eliminar datos y mucho más!
 
@@ -45,15 +66,18 @@ NOTA: Recuerda revisar la información del archivo ./.env para obtener el nombre
 Crea un archivo .env en el directorio raíz del proyecto para almacenar tus variables de entorno, como tu cadena de conexión a la base de datos:
 
 ```makefile
-DATABASE_URL="your_database_connection_url_here"
+DATABASE_URL="postgresql://<USUARIO>:<CONTRASEÑA>@<HOST>:<PUERTO>/<NOMBRE_BD>"
+
+#example
+DATABASE_URL="postgresql://mi_usuario:mi_contraseña@localhost:5432/mi_base_de_datos"
 ```
 
 ## Ejecutando la Aplicación
 
 Para ejecutar la aplicación, ejecuta el script app.py desde la raíz del directorio del proyecto:
 
 ```bash
-python app.py
+python src/app.py
 ```
 
 ## Añadiendo Modelos
@@ -63,16 +87,16 @@ Para añadir clases de modelos SQLAlchemy, crea nuevos archivos de script de Pyt
 Definición del modelo de ejemplo (`models/example_model.py`):
 
 ```py
-from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy import Column, Integer, String
+from sqlalchemy.orm import DeclarativeBase
+from sqlalchemy import String
+from sqlalchemy.orm import Mapped, mapped_column
 
 Base = declarative_base()
 
 class ExampleModel(Base):
     __tablename__ = 'example_table'
-    id = Column(Integer, primary_key=True)
-    name = Column(String)
-
+    id: Mapped[int] = mapped_column(primary_key=True)
+    username: Mapped[str] = mapped_column(unique=True)
 ```
 
 ## Trabajando con Datos

README.md

@@ -6,22 +6,32 @@ This boilerplate is designed to kickstart data science projects by providing a b
 
 The project is organized as follows:
 
-- `app.py` - The main Python script that you run for your project.
-- `explore.py` - A notebook to explore data, play around, visualize, clean, etc. Ideally the notebook code should be migrated to the app.py when moving to production.
-- `utils.py` - This file contains utility code for operations like database connections.
-- `requirements.txt` - This file contains the list of necessary python packages.
-- `models/` - This directory should contain your SQLAlchemy model classes.
-- `data/` - This directory contains the following subdirectories:
-  - `interin/` - For intermediate data that has been transformed.
-  - `processed/` - For the final data to be used for modeling.
-  - `raw/` - For raw data without any processing.
- 
-    
-## Setup
+- **`src/app.py`** → Main Python script where your project will run.
+- **`src/explore.ipynb`** → Notebook for exploration and testing. Once exploration is complete, migrate the clean code to `app.py`.
+- **`src/utils.py`** → Auxiliary functions, such as database connection.
+- **`requirements.txt`** → List of required Python packages.
+- **`models/`** → Will contain your SQLAlchemy model classes.
+- **`data/`** → Stores datasets at different stages:
+  - **`data/raw/`** → Raw data.
+  - **`data/interim/`** → Temporarily transformed data.
+  - **`data/processed/`** → Data ready for analysis.
+
+
+## ⚡ Initial Setup in Codespaces (Recommended)
+
+No manual setup is required, as **Codespaces is automatically configured** with the predefined files created by the academy for you. Just follow these steps:
+
+1. **Wait for the environment to configure automatically**.
+   - All necessary packages and the database will install themselves.
+   - The automatically created `username` and `db_name` are in the **`.env`** file at the root of the project.
+2. **Once Codespaces is ready, you can start working immediately**.
+
+
+## 💻 Local Setup (Only if you can't use Codespaces)
 
 **Prerequisites**
 
-Make sure you have Python 3.11+ installed on your. You will also need pip for installing the Python packages.
+Make sure you have Python 3.11+ installed on your machine. You will also need pip to install the Python packages.
 
 **Installation**
 
@@ -33,57 +43,70 @@ Navigate to the project directory and install the required Python packages:
 pip install -r requirements.txt
 ```
 
-**Create a database (if needed)**
+**Create a database (if necessary)**
+
+Create a new database within the Postgres engine by customizing and executing the following command:
 
-Create a new database within the Postgres engine by customizing and executing the following command: `$ createdb -h localhost -U <username> <db_name>`
-Connect to the Postgres engine to use your database, manipulate tables and data: `$ psql -h localhost -U <username> <db_name>`
-NOTE: Remember to check the ./.env file information to get the username and db_name.
+```bash
+$ psql -U postgres -c "DO \$\$ BEGIN 
+    CREATE USER my_user WITH PASSWORD 'my_password'; 
+    CREATE DATABASE my_database OWNER my_user; 
+END \$\$;"
+```
+Connect to the Postgres engine to use your database, manipulate tables, and data:
 
-Once you are inside PSQL you will be able to create tables, make queries, insert, update or delete data and much more!
+```bash
+$ psql -U my_user -d my_database
+```
+
+Once inside PSQL, you can create tables, run queries, insert, update, or delete data, and much more!
 
 **Environment Variables**
 
-Create a .env file in the project root directory to store your environment variables, such as your database connection string:
+Create a .env file in the root directory of the project to store your environment variables, such as your database connection string:
 
 ```makefile
-DATABASE_URL="your_database_connection_url_here"
+DATABASE_URL="postgresql://<USER>:<PASSWORD>@<HOST>:<PORT>/<DB_NAME>"
+
+#example
+DATABASE_URL="postgresql://my_user:my_password@localhost:5432/my_database"
 ```
 
 ## Running the Application
 
-To run the application, execute the app.py script from the root of the project directory:
+To run the application, execute the app.py script from the root directory of the project:
 
 ```bash
-python app.py
+python src/app.py
 ```
 
 ## Adding Models
 
-To add SQLAlchemy model classes, create new Python script files inside the models/ directory. These classes should be defined according to your database schema.
+To add SQLAlchemy model classes, create new Python script files within the models/ directory. These classes should be defined according to your database schema.
 
 Example model definition (`models/example_model.py`):
 
 ```py
-from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy import Column, Integer, String
+from sqlalchemy.orm import declarative_base
+from sqlalchemy import String
+from sqlalchemy.orm import Mapped, mapped_column
 
 Base = declarative_base()
 
 class ExampleModel(Base):
     __tablename__ = 'example_table'
-    id = Column(Integer, primary_key=True)
-    name = Column(String)
-
+    id: Mapped[int] = mapped_column(primary_key=True)
+    username: Mapped[str] = mapped_column(unique=True)
 ```
 
 ## Working with Data
 
-You can place your raw datasets in the data/raw directory, intermediate datasets in data/interim, and the processed datasets ready for analysis in data/processed.
+You can place your raw datasets in the data/raw directory, intermediate datasets in data/interim, and processed datasets ready for analysis in data/processed.
 
-To process data, you can modify the app.py script to include your data processing steps, utilizing pandas for data manipulation and analysis.
+To process data, you can modify the app.py script to include your data processing steps, using pandas for data manipulation and analysis.
 
 ## Contributors
 
-This template was built as part of the 4Geeks Academy [Data Science and Machine Learning Bootcamp](https://4geeksacademy.com/us/coding-bootcamps/datascience-machine-learning) by [Alejandro Sanchez](https://twitter.com/alesanchezr) and many other contributors. Find out more about [4Geeks Academy's BootCamp programs](https://4geeksacademy.com/us/programs) here.
+This template was built as part of the [Data Science and Machine Learning Bootcamp](https://4geeksacademy.com/us/coding-bootcamps/datascience-machine-learning) by 4Geeks Academy by [Alejandro Sanchez](https://twitter.com/alesanchezr) and many other contributors. Learn more about [4Geeks Academy BootCamp programs](https://4geeksacademy.com/us/programs) here.
 
-Other templates and resources like this can be found on the school GitHub page.
+Other templates and resources like this can be found on the school's GitHub page.

requirements.txt

@@ -10,6 +10,6 @@ python-dotenv>=0.20.0
 requests>=2.27.1
 scikit-learn
 seaborn>=0.12.2
-sqlalchemy>=1.4.37
+sqlalchemy>=2.0.38
 sympy>=1.10.1
 xgboost