search

diegoabeltran16 / Passive-Expenses-Bot

A tool for logging, viewing, and managing passive expenses | Una herramienta para registrar, ver y gestionar gastos pasivos
MIT License
0 stars 0 forks source link

1.1 #6

Closed diegoabeltran16 closed 1 month ago

diegoabeltran16 commented 1 month ago
diegoabeltran16 commented 1 month ago

1.1

Configurar la estructura de directorios del proyecto

Establecimos una estructura de directorios clara y organizada para el proyecto con el fin de garantizar la escalabilidad y la facilidad de desarrollo. La estructura separa los componentes principales como la lógica del bot, comandos, configuración y utilidades en diferentes directorios.

La estructura final de directorios es la siguiente:

Passive-Expenses-Bot/
│
├── docs/               # Documentación y referencias API
│   ├── api_reference.md
│   ├── setup.md
│   └── usage.md
│
├── src/                # Código fuente
│   ├── commands/       # Archivos de comandos modulares (log_expense, delete_expense)
│   │   ├── log_expense.py
│   │   └── delete_expense.py
│   ├── config/         # Archivos de configuración
│   │   └── config.yaml
│   ├── bot.py          # Script del bot principal
│   └── utils/          # Scripts de utilidades (por ampliar)
│
├── tests/              # Archivos de prueba para comandos y utilidades
│   └── test_commands/
│
├── requirements.txt    # Dependencies list
├── sync_feature.sh     # Script para sincronizar ramas de características
├── sync_branch.sh      # Script para sincronizar ramas
└── .gitignore          # Archivos ignorados para Git

Inicializar el repositorio Git

Para gestionar el control de versiones, se inicializó el repositorio Git y se configuró lo siguiente:

Utilizamos GitHub y GitLab como repositorios remotos para sincronizar el proyecto. El repositorio se inicializó en el directorio src/, y los repositorios remotos se añadieron utilizando tokens de acceso para la autenticación.

Se crearon varias ramas para gestionar diferentes ciclos y características:

main: La principal rama de producción. cycle-1-basic-setup: La rama para el ciclo inicial de trabajo de configuración. feature/command-handling: La rama en la que se desarrolló la función de gestión de comandos. Utilizamos scripts bash personalizados (sync_branch.sh, sync_feature.sh) para sincronizar entre ramas y garantizar una colaboración fluida entre GitHub y GitLab.

Preparar requirements.txt

Identificamos las bibliotecas básicas necesarias para el proyecto y las documentamos en el archivo requirements.txt.

Estas bibliotecas son esenciales para el funcionamiento del bot y su futura escalabilidad:

discord.py: La biblioteca principal para interactuar con la API de Discord. PyYAML: Una biblioteca utilizada para leer y gestionar archivos de configuración YAML para la configuración de bots.

Conclusión

El objetivo especifico 1.1 del ciclo 1 sentó las bases para el proyecto Passive-Expenses-Bot estableciendo una estructura de directorios limpia, inicializando el control de versiones Git y preparando las dependencias del proyecto. Con la configuración básica completa, el proyecto está ahora listo para expandirse a funcionalidades más complejas, como el manejo de comandos y la integración de bases de datos en ciclos futuros.

diegoabeltran16 commented 1 month ago

Completed