initial commit
This commit is contained in:
136
scripts/README.md
Normal file
136
scripts/README.md
Normal file
@@ -0,0 +1,136 @@
|
||||
# 🛠️ Scripts de Utilidades
|
||||
|
||||
Este directorio contiene scripts útiles para el desarrollo y mantenimiento del proyecto Balotario.
|
||||
|
||||
## 📁 Scripts Disponibles
|
||||
|
||||
### 🐍 `dev.py`
|
||||
**Script principal de desarrollo en Python**
|
||||
|
||||
#### Comandos:
|
||||
```bash
|
||||
# Limpiar cache y archivos temporales
|
||||
python scripts/dev.py clean
|
||||
|
||||
# Ejecutar todos los tests de Python
|
||||
python scripts/dev.py test
|
||||
|
||||
# Verificar dependencias instaladas
|
||||
python scripts/dev.py deps
|
||||
|
||||
# Iniciar servidor de desarrollo
|
||||
python scripts/dev.py dev
|
||||
|
||||
# Mostrar ayuda
|
||||
python scripts/dev.py help
|
||||
```
|
||||
|
||||
#### Funcionalidades:
|
||||
- ✅ Limpieza automática de `__pycache__` y archivos `.pyc`
|
||||
- ✅ Ejecución de tests de Python
|
||||
- ✅ Verificación de dependencias
|
||||
- ✅ Inicio del servidor de desarrollo
|
||||
- ✅ Ayuda integrada
|
||||
|
||||
### 🧹 `clean.sh`
|
||||
**Script de limpieza rápida en Bash**
|
||||
|
||||
#### Uso:
|
||||
```bash
|
||||
# Ejecutar limpieza completa
|
||||
./scripts/clean.sh
|
||||
|
||||
# O con bash explícito
|
||||
bash scripts/clean.sh
|
||||
```
|
||||
|
||||
#### Funcionalidades:
|
||||
- ✅ Elimina `__pycache__` recursivamente
|
||||
- ✅ Elimina archivos `.pyc`, `.pyo`
|
||||
- ✅ Elimina archivos temporales (`.tmp`, `.temp`, `*~`)
|
||||
- ✅ Elimina archivos del sistema (`.DS_Store`)
|
||||
- ✅ Elimina logs (`.log`)
|
||||
- ✅ Muestra estadísticas del proyecto
|
||||
|
||||
## 🚀 Uso Rápido
|
||||
|
||||
### Desarrollo Diario
|
||||
```bash
|
||||
# 1. Limpiar proyecto
|
||||
./scripts/clean.sh
|
||||
|
||||
# 2. Verificar que todo esté bien
|
||||
python scripts/dev.py test
|
||||
|
||||
# 3. Iniciar desarrollo
|
||||
python scripts/dev.py dev
|
||||
```
|
||||
|
||||
### Antes de Commit
|
||||
```bash
|
||||
# Limpiar y verificar
|
||||
./scripts/clean.sh
|
||||
python scripts/dev.py test
|
||||
```
|
||||
|
||||
### Configuración Inicial
|
||||
```bash
|
||||
# Verificar dependencias
|
||||
python scripts/dev.py deps
|
||||
|
||||
# Si faltan dependencias
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## 🔧 Personalización
|
||||
|
||||
### Agregar Nuevos Comandos a `dev.py`
|
||||
1. Crear nueva función en `dev.py`
|
||||
2. Agregar comando en `main()`
|
||||
3. Documentar en `show_help()`
|
||||
|
||||
### Modificar `clean.sh`
|
||||
- Agregar nuevos patrones de archivos a limpiar
|
||||
- Modificar las estadísticas mostradas
|
||||
- Agregar verificaciones adicionales
|
||||
|
||||
## 📊 Estadísticas
|
||||
|
||||
El script `clean.sh` muestra:
|
||||
- 📁 Directorio actual
|
||||
- 📄 Número de archivos Python
|
||||
- 🌐 Número de archivos HTML
|
||||
- 🎨 Número de archivos CSS
|
||||
- ⚡ Número de archivos JavaScript
|
||||
- 🧪 Número de tests
|
||||
|
||||
## 🐛 Troubleshooting
|
||||
|
||||
### Permisos en Linux/macOS
|
||||
```bash
|
||||
# Dar permisos de ejecución
|
||||
chmod +x scripts/clean.sh
|
||||
chmod +x scripts/dev.py
|
||||
```
|
||||
|
||||
### Problemas con Python
|
||||
```bash
|
||||
# Verificar versión de Python
|
||||
python --version
|
||||
|
||||
# Verificar que esté en el entorno virtual
|
||||
which python
|
||||
```
|
||||
|
||||
### Problemas con Bash
|
||||
```bash
|
||||
# Ejecutar con bash explícito
|
||||
bash scripts/clean.sh
|
||||
|
||||
# Verificar sintaxis
|
||||
bash -n scripts/clean.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Nota**: Estos scripts están diseñados para facilitar el desarrollo. Úsalos regularmente para mantener el proyecto limpio y organizado.
|
||||
Reference in New Issue
Block a user