👨💻 Contribuire¶
Workflow consigliato¶
# 1. Prima configurazione
python streaming_installer.py # setup venv + dipendenze
# 2. Sviluppo quotidiano
python streaming_installer.py --format # formatta prima del commit
python streaming_installer.py --lint # controlla la qualità del codice
# 3. Rilascio
python streaming_installer.py --install # build completo + deploy
Strumenti di sviluppo¶
L'installer installa automaticamente, oltre alle dipendenze del progetto:
| Strumento | Scopo |
|---|---|
| PyInstaller | Compilazione dell'eseguibile .exe |
| autopep8 | Formattazione automatica del codice |
| pylint | Analisi statica del codice |
| MkDocs + mkdocs-material | Generazione della documentazione |
| mkdocstrings | Documentazione automatica dal codice |
Documentazione¶
La documentazione viene pubblicata automaticamente su streaming-sc-python.pages.dev tramite Cloudflare Pages ad ogni push su master.
Per generarla e visualizzarla in locale:
Tip
mkdocs serve avvia un server locale su http://127.0.0.1:8000/ con hot-reload automatico ad ogni modifica.
.gitignore¶
Le seguenti cartelle e file sono esclusi dal repository:
/.idea/ # IDE JetBrains
/__pycache__/ # cache Python
/build/ # output PyInstaller
/dist/ # eseguibile compilato
/venv/ /.venv/ # virtual environment
/site/ # documentazione generata
/client_id.json # credenziali Google
/token.json # token OAuth2
/streaming.log # log applicazione
.env # variabili d'ambiente
*.whl # pacchetti wheel