From 5877887a8d62ead48d964c686c0463df5b49bb61 Mon Sep 17 00:00:00 2001 From: Ruben Herrera Date: Sun, 23 Nov 2025 21:51:57 -0400 Subject: [PATCH] Update INSTRUCTIONS.es.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Correcciones de acentuación y redacción en las instrucciones --- INSTRUCTIONS.es.md | 126 ++++++++++++++++----------------------------- 1 file changed, 43 insertions(+), 83 deletions(-) diff --git a/INSTRUCTIONS.es.md b/INSTRUCTIONS.es.md index 854e2c022..757f11015 100644 --- a/INSTRUCTIONS.es.md +++ b/INSTRUCTIONS.es.md @@ -1,94 +1,59 @@ # Conectarse a una base de datos SQL usando Python -## Parte 1: Instala dependencias - -Hay un archivo en este proyecto llamado `./requirements.txt` que contiene la lista de bibliotecas de Python que usaremos en este proyecto como Pandas, psycopg2, SQLAlchemy, etc. Ejecuta el comando `pip install -r requirements.txt` para instalar todas las bibliotecas a la vez usando el asistente PIP (*Package Installer of Python*, Instalador de Paquetes de Python). - -> NOTA: Asegúrate de que el comando no genere ningún error en el terminal. - -## Parte 2: Incluye las credenciales de tu base de datos - -Para conectar tu aplicación con la base de datos, debes configurar un archivo `.env` en la raíz del proyecto. Este archivo almacena credenciales y configuraciones sensibles de forma segura y debe ser ignorado por Git para evitar exponer información confidencial. En la raíz del proyecto encontrarás un archivo llamado .env.example, que contiene un formato de referencia para las credenciales de la base de datos. - -Crea y abre el archivo `.env` y agrega las credenciales de tu base de datos. - -Si ejecutas la base de datos en local: - - - DB_HOST="localhost" - DB_PORT= 3306 - DB_USER="tu_usuario" - DB_PASSWORD="tu_contraseña" - DB_NAME="nombre_de_tu_base" - - -Si tu base de datos está alojada en un servicio en la nube, usa las credenciales proporcionadas por tu proveedor (los valores que se incluyen son de ejemplo): - - - DB_HOST="f565gmi022AD.cbetxkdyhwsb.us-east-1.rds.amazonaws.com" - DB_PORT=3306 # Ajusta el puerto según el servicio - DB_USER="hkietatgd83b4x0l" - DB_PASSWORD="p0s2wasdado1cr02d12" - DB_NAME="y9uflxvx2hsf11g3f" - - - -## Parte 3: Crea una base de datos usando PostgreSQL +## Parte 1: Crea una base de datos usando PostgreSQL Asegúrate de tener instalado el cliente de Postgres para la terminal llamado `PSQL`. Puedes verificar si lo tienes corriendo el siguiente comando: -```bash +``` $ psql --version ``` -> NOTA: Si da un error, intenta [seguir las instrucciones en este artículo](https://www.timescale.com/blog/how-to-install-psql-on-mac-ubuntu-debian-windows/) para instalar `psql` en tu computadora. - -A continuación, revisa el contenido del archivo `./.env` y sigue los pasos que se describen a continuación: +> NOTA: Si da un error, intenta [seguir las intrucciones en este articulo](https://www.timescale.com/blog/how-to-install-psql-on-mac-ubuntu-debian-windows/). -1. Postgres es un servidor de bases de datos, debes iniciar el servidor antes de poder usarlo. Para iniciar Postgres en tu computadora, ejecuta el siguiente comando: `sudo service postgresql start` -2. Crea un usuario nuevo para conectarte a tu base de datos: `$ psql -U postgres -c "CREATE USER ;"` -Este comando significa lo siguiente: +A continuación, revisa el contenido del archivo `./.env` y sigue los pasos que se describen: - - `$ psql -U postgres → Conéctate a PostgreSQL usando el usuario administrador predeterminado (postgres)`. - - `$ -c "CREATE USER ;" → Ejecuta el comando SQL para crear un usuario llamado `. +1. Crea una nueva base de datos dentro del motor de Postgres personalizando y ejecutando el siguiente comando: `$ createdb -h localhost -U ` +2. Conéctate al motor de Postgres para utilizar tu base de datos, manipular tablas y datos: `$ psql -h localhost -U ` - Si en el .env tienes: +> NOTA: Recuerda revisar la información del fichero `./.env` para obtener el `username` y el `db_name`. - DB_USER = 'mi_usuario' - El comando que debes ejecutar es: +¡Cuando estés dentro de PSQL podrás crear tablas, hacer consultas, insertar, actualizar o eliminar datos y mucho más! - `$ psql -U postgres -c "CREATE USER mi_usuario;"` +## Parte 2: Comprende la estructura de la plantilla de tu proyecto -3. Crea una nueva base de datos dentro del motor de Postgres personalizando y ejecutando el siguiente comando:`$ psql -U postgres -c "CREATE DATABASE OWNER ;"`. +Una vez hayas completado los pasos anteriores, habrás creado tu base de datos SQL, pero aún no hay tablas. A continuación, debes conectarte a tu base de datos vacía y crearás algunas tablas usando Python mediante scripts SQL que encontrarás en la carpeta `./src/sql/`: - Si en tu .env tienes: +- `./src/sql/create.sql` con todas las tablas que necesitas crear. Manos en la creación de esas tablas. +- `./src/sql/insert.sql` con todos los valores de la tabla que se insertarán en cada tabla. +- `./src/sql/drop.sql` contiene el código SQL para borrar las tablas, muy útil para limpiar tu base de datos. - DB_NAME = 'mi_base_de_datos' - DB_USER = 'mi_usuario' +Otras cosas importantes a mencionar sobre la estructura: - Entonces el comando sería: +- Los proyectos profesionales suelen tener una carpeta `./src` que contiene todos los **archivos de codificación** (los archivos que implementará el desarrollador). +- `./assets` es irrelevante para ti, contiene todas las imágenes que necesitábamos para este tutorial. +- La `raíz` de cualquier proyecto profesional suele contener todos los archivos de configuración como `.gitignore`, `requirements.txt`, etc. Aprenderás más sobre estos archivos durante el resto del proyecto. - `$ psql -U postgres -c "CREATE DATABASE mi_base_de_datos OWNER mi_usuario;"` -4. Conéctate al motor de Postgres para utilizar tu base de datos, manipular tablas y datos: `$ psql -h localhost -U ` +## Parte 3: Instala dependencias -> Recuerda revisar la información del fichero `./.env` para obtener el `username` y el `db_name`. +Hay un archivo en este proyecto llamado `./requirements.txt` que contiene la lista de bibliotecas de python que usaremos en este proyecto como Pandas, psycopg2, SQLAlchemy, etc. Ejecuta el comando `pip install -r requirements.txt` para instalar todas las bibliotecas a la vez usando el asistente PIP (*Package Installer of Python*, Instalador de Paquetes de Python). -¡Cuanto estés dentro de PSQL podrás crear tablas, hacer consultas, insertar, actualizar o eliminar datos y mucho más! +> NOTA: Asegúrate de que el comando no genere ningún error en el terminal. -## Parte 4: Comprende la estructura de la plantilla de tu proyecto +## Parte 4: Incluye las credenciales de tu base de datos -Una vez hayas completado los pasos anteriores, habrás creado tu base de datos SQL, pero aún no hay tablas. A continuación, debes conectarte a tu base de datos vacía y crearás algunas tablas usando Python mediante scripts SQL que encontrarás en la carpeta `./src/sql/`: +Crea tu archivo `./.env`. Es una buena práctica que cada aplicación de Python tenga un archivo `.env`. El nombre del archivo comienza con un punto `.` porque es un archivo de configuración que será ignorado por tu repositorio Git. Debe ignorarse porque agregaremos la contraseña de nuestra base de datos dentro de ese archivo. -- `./src/sql/create.sql` con todas las tablas que necesitas crear. Manos a la obra en la creación de esas tablas. -- `./src/sql/insert.sql` con todos los registros que se insertarán en cada tabla. -- `./src/sql/drop.sql` contiene el código SQL para borrar las tablas, muy útil para limpiar tu base de datos. +Escribe las credenciales de tu base de datos dentro del archivo `.env`. Debería quedar algo así (los valores que se incluyen son de ejemplo): -Otras cosas importantes a mencionar sobre la estructura: - -- Los proyectos profesionales suelen tener una carpeta `./src` que contiene todos los **archivos de código** (los archivos que implementará el desarrollador). -- `./assets` es irrelevante para ti, contiene todas las imágenes que necesitábamos para este tutorial. -- La raíz (*root*) de cualquier proyecto profesional suele contener todos los archivos de configuración como `.gitignore`, `requirements.txt`, etc. Aprenderás más sobre estos archivos durante el resto del proyecto. +``` +DB_USER = 'hkietatgd83b4x0l' +DB_PASSWORD = 'p0s2wasdado1cr02d12' +DB_PORT = 3306 +DB_HOST = 'f565gmi022AD.cbetxkdyhwsb.us-east-1.rds.amazonaws.com' +DB_NAME = 'y9uflxvx2hsf11g3f' +``` +> NOTA: Asegúrate de reemplazar estos valores con tus credenciales de base de datos reales. ## Parte 5: Empieza a programar @@ -98,26 +63,22 @@ Todo tu código de Python siempre debe estar dentro de la carpeta `src`, esta ta ```py def connect(): - global engine - try: - connection_string = f"postgresql://{os.getenv('DB_USER')}:{os.getenv('DB_PASSWORD')}@{os.getenv('DB_HOST')}/{os.getenv('DB_NAME')}" - print("Starting the connection...") - engine = create_engine(connection_string, isolation_level="AUTOCOMMIT") - engine.connect() - print("Connected successfully!") - return engine - except Exception as e: - print(f"Error connecting to the database: {e}") - return None + global engine # Esto nos permite usar una variable global llamada motor + # Una "cadena de conexión" es básicamente una cadena que contiene todas las credenciales de la base de datos juntas + connection_string = f"postgresql://{os.getenv('DB_USER')}:{os.getenv('DB_PASSWORD')}@{os.getenv('DB_HOST')}/{os.getenv('DB_NAME')}?autocommit=true" + print("Starting the connection...") + engine = create_engine(connection_string) + engine.connect() + return engine ``` ## 📝 Instrucciones -1. Vamos a trabajr en el archivo dentro de la carpeta `src` llamado `./src/app.py`. +1. Vamos a crear un archivo dentro de la carpeta `src` llamado `./src/app.py`. > NOTA: Este archivo contendrá la mayor parte del código de tu aplicación, así como la conexión a la base de datos y las consultas a la base de datos. -2. Crea una base de datos PostgreSQL tal y como se indica en la guia. +2. Crea una base de datos PostgreSQL tal y como se indica en la parte 1. 3. En tu `app.py`, programa la conexión con tu base de datos. @@ -125,14 +86,13 @@ def connect(): 4. Crea las tablas indicadas en `./src/sql/create.sql`. -5. Inserta los datos indicados de `./src/sql/insert.sql` en las tablas creadas en el punto anterior. +5. Inserta los datos indicados en `./src/sql/insert.sql` en las tablas creadas en el punto anterior. -6. Usa Pandas para imprimir una de las tablas como DataFrame usando la función `read_sql` de esta librería. +6. Usa Pandas para imprimir una de las tablas como DataFrame usando la función `read_sql` de esta librería... ## Tips adicionales -- Inicia sesión en tu base de datos usando: `psql -h localhost -U postgres` +- Inicia sesión en tu base de datos usando: `psql -h localhost -u postgres` - Conéctate a una base de datos remota usando: `psql -h -p -U ` - Elimina una base de datos: `$ dropdb -h localhost -U ` - Crea una BD en la nube de render.com y conéctate [siguiendo estos comandos](https://render.com/docs/databases#connecting-from-outside-render). -