Prerequisiti

Per partecipare allo sviluppo dell’applicativo vero e proprio saranno necessari i seguenti prerequisiti:

python (>3.9)
poetry
pipx (consigliato)

Per testare visivamente le modifiche alla documentazione invece, sarà necessario avere installato:

ruby
gem
jekyll

Table of contents

Prerequisiti
- Pacchetti per lo sviluppo
  - Installazione pipx e poetry
  - Installazione dipendenze Python
- Pacchetti per la documentazione

Pacchetti per lo sviluppo

Questi pacchetti sono fondamentali per lo sviluppo e compilazione del programma finale.

Installazione `pipx` e `poetry`

L’installazione di poetry può essere effettuata anche senza utilizzare pipx, ma l’ho preferito per una questione di semplicità rispetto agli altri metodi.

Installa pipx:
```
 python -m pip install --user pipx
```
Aggiungi pipx alla variabile d’ambiente PATH:
```
 pipx ensurepath
```
Installa poetry:
```
pipx install poetry
```
Riavvia la shell

Installazione dipendenze Python

Una volta installati i software necessari, bisognerà installare anche le dipendenze che permetteranno al programma di funzionare.

Questo si può fare con il comando:

poetry install

Ora è possibile eseguire i singoli file Python usando il comando:
poetry run python [file_da_eseguire]

Pacchetti per la documentazione

Sotto questa categoria ricadono tutti i pacchetti non necessari all’esecuzione del programma o alla sua compilazione, ma che invece vengono utilizzati per testare localmente la documentazione che stai leggendo in questo momento 😃

Una volta effettuati tutti i passi spiegati di seguito sarà possibile vedere la documentazione nel proprio browser tramite il comando poetry run poe docs

Installazione `ruby`

Segui le istruzioni contenute nel sito web ufficiale di Jekyll.

Installazione `gem`

Segui le istruzioni contenute nel sito web ufficiale di RubyGem.

Installazione `jekyll`

gem install jekyll bundler

Scripts

Build

Lancia il processo di build:

poetry run build

Release

poetry run release