SXXXXXXX_ProjectInitializer/doc/Italian-manual.md
2025-05-07 14:47:22 +02:00

7.4 KiB

Project Initializer Tool - Manuale Italiano

1. Introduzione

Benvenuto nel Project Initializer Tool! Questa applicazione ti aiuta a configurare rapidamente una struttura di directory standardizzata e file di base essenziali per nuovi progetti Python, specialmente quelli destinati a essere gestiti con Git.

Automatizza la creazione di cartelle comuni (come sorgente, documentazione, core, gui), file Python iniziali (__init__.py, __main__.py), un file .gitignore, un README.md di base, un template di file .spec per PyInstaller, e inizializza persino un repository Git locale.

Lo strumento può essere utilizzato tramite una semplice Interfaccia Utente Grafica (GUI) o attraverso l'Interfaccia a Riga di Comando (CLI).

2. Funzionalità

  • Crea una cartella principale per il progetto.
  • Imposta una cartella annidata per il codice sorgente (es., NomeProgetto/nomeprogetto_src/).
  • Genera una struttura di pacchetto Python standard all'interno della cartella sorgente:
    • nomeprogetto_src/core/__init__.py, nomeprogetto_src/core/core.py
    • nomeprogetto_src/gui/__init__.py, nomeprogetto_src/gui/gui.py
    • nomeprogetto_src/__init__.py, nomeprogetto_src/__main__.py (configurato per essere eseguibile con python -m nomeprogetto_src)
  • Crea una directory doc/ con file template English-manual.md e Italian-manual.md per il nuovo progetto.
  • Genera un file README.md di base per il nuovo progetto.
  • Crea un template di file .spec per PyInstaller, configurato per il nuovo progetto.
  • Copia un file icona predefinito .ico nel nuovo progetto.
  • Crea un file .gitignore completo, adatto per progetti Python.
  • Inizializza un repository Git locale nella directory principale del nuovo progetto ed esegue un commit iniziale.
  • Supporta l'operatività sia tramite GUI (Tkinter) che CLI.
  • Ricorda l'ultima directory radice utilizzata per la creazione di progetti (modalità GUI).

3. Utilizzo dell'Interfaccia Utente Grafica (GUI)

La GUI fornisce un modo interattivo per creare nuovi progetti.

3.1. Avvio della GUI

  1. Naviga nella directory in cui si trova ProjectInitializerTool.
  2. Esegui lo strumento dal tuo terminale utilizzando l'esecuzione del modulo Python:
    python -m project_initializer
    
    (Assumendo che project_initializer sia il nome della cartella principale del pacchetto di questo strumento). Questo aprirà la finestra "Project Initializer Tool".

3.2. Componenti della GUI

  • Directory Radice (Root Directory):
    • Campo di Testo: Visualizza il percorso della directory in cui verrà creata la cartella del tuo nuovo progetto. Questo campo sarà precompilato con l'ultima directory radice utilizzata, o la directory home del tuo utente al primo utilizzo.
    • Pulsante Sfoglia... (Browse...): Clicca qui per aprire una finestra di dialogo e selezionare una directory radice diversa.
  • Nome Progetto (Project Name):
    • Campo di Testo: Inserisci il nome desiderato per il tuo nuovo progetto (es., "MiaAppFantastica", "AnalizzatoreDati"). Questo nome verrà utilizzato per la cartella principale del progetto. Una versione "sanificata" (minuscolo, underscore al posto di spazi/trattini) verrà usata per il nome del pacchetto sorgente interno.
  • Pulsante Crea Progetto (Create Project): (Precedentemente "Procedi") Clicca questo pulsante dopo aver compilato la Directory Radice e il Nome Progetto per avviare il processo di creazione del progetto.

3.3. Creazione di un Progetto (GUI)

  1. Avvia la GUI come descritto sopra.
  2. Imposta la Directory Radice:
    • Usa il percorso precompilato oppure clicca "Sfoglia..." per selezionare la directory genitore in cui vuoi che venga creata la cartella del tuo nuovo progetto.
    • Esempio: Se selezioni C:\Dev\ProgettiPython come directory radice.
  3. Inserisci il Nome Progetto:
    • Digita il nome per il tuo nuovo progetto nel campo "Nome Progetto".
    • Esempio: MiaNuovaUtility
  4. Clicca "Crea Progetto":
    • Lo strumento controllerà se una cartella con lo stesso nome progetto esiste già nella directory radice specificata.
      • Se esiste, verrà visualizzato un messaggio di errore e il processo si interromperà.
      • Se non esiste, lo strumento creerà l'intera struttura del progetto e i file come descritto nella sezione "Funzionalità".
  5. Feedback:
    • Messaggi verranno stampati sulla console (se visibile) che dettagliano ogni passo del processo di creazione.
    • Una finestra di messaggio di successo o errore apparirà nella GUI al completamento o in caso di fallimento.
    • In caso di successo, il campo "Nome Progetto" nella GUI verrà svuotato, pronto per inizializzare un altro progetto. La "Directory Radice" selezionata verrà ricordata per il prossimo utilizzo dello strumento.

4. Utilizzo dell'Interfaccia a Riga di Comando (CLI)

La CLI è utile per lo scripting o per gli utenti che preferiscono le operazioni da riga di comando.

4.1. Avvio tramite CLI

  1. Apri il tuo terminale o prompt dei comandi.
  2. Naviga nella directory in cui si trova ProjectInitializerTool.
  3. Esegui lo strumento con gli argomenti richiesti:
    python -m project_initializer <root_directory> <NomeProgetto>
    
    • <root_directory>: Il percorso assoluto o relativo della directory in cui verrà creata la cartella del nuovo progetto.
    • <NomeProgetto>: Il nome desiderato per il tuo nuovo progetto.

4.2. Argomenti CLI

  • root_directory (Posizionale, Richiesto):
    • Specifica la directory genitore per il nuovo progetto.
    • Esempio: /home/utente/dev/python/ o D:\Lavoro\MieiProgettiPython
  • project_name (Posizionale, Richiesto):
    • Specifica il nome per la cartella del nuovo progetto.
    • Esempio: AppFiga, WebScraperV2

4.3. Creazione di un Progetto (CLI) - Esempio

Per creare un nuovo progetto chiamato "ElaboratoreDati" all'interno della directory /mnt/dati/progetti/progetti_python:

python -m project_initializer /mnt/dati/progetti/progetti_python ElaboratoreDati

Output:

  • Lo strumento stamperà messaggi sulla console che indicano l'avanzamento della creazione di directory e file, e l'inizializzazione di Git.
  • Se la directory del progetto (/mnt/dati/progetti/progetti_python/ElaboratoreDati) esiste già, verrà stampato un messaggio di errore e lo script terminerà.
  • Al completamento con successo, verrà visualizzato un messaggio di conferma.

5. File di Configurazione

Il Project Initializer Tool salva la propria configurazione (specificamente, l'ultima directory radice utilizzata per la GUI) in un file JSON chiamato .project_initializer_config.json. Questo file è memorizzato nella directory home del tuo utente.

6. Note

  • Icona Predefinita: Lo strumento copia un file default_icon.ico nei nuovi progetti. Questa icona proviene dalla directory project_initializer/assets/ all'interno del pacchetto stesso del Project Initializer Tool. Assicurati che questa icona esista se stai modificando lo strumento.
  • Requisito Git: Affinché l'inizializzazione del repository Git funzioni, devi avere Git installato e accessibile nel PATH del tuo sistema. Se Git non viene trovato, la struttura del progetto verrà comunque creata, ma il repository Git non verrà inizializzato (verrà stampato un avviso).

Grazie per aver utilizzato il Project Initializer Tool!