Installazione

Prerequisiti

Il tool è attualmente compatibile soltanto con Windows (stiamo lavorando al supporto per Linux).

La dipendenza principale è Python 3.8, che può essere installato tramite choco oppure tramite il pacchetto ufficiale.

Download

Il modo più veloce per ottenere il tool è scaricare l’ultima release da Github ed estrarre i file compressi.

In alternativa, git può essere utilizzato direttamente. Questa soluzione permette di mantenere il tool aggiornato con più facilità. Una volta installato git, eseguire:

$ git clone https://github.com/CarloDePieri/odk_servermanager.git odksm

Installazione

L’utilizzo di un virtual environment python è fortemente consigliato: installare pipenv e preparare il venv dando questi comandi dentro la root directory di ODKSM:

$ pip install pipenv
$ python -m venv .venv

Quando il venv è pronto, installare ODKSM e le sue dipendenze dentro il venv con:

$ pipenv install --dev

Update

Se è stata usata la release zippata, va scaricata la release più recente e il contenuto estratto deve andare a sostituire la vecchia cartella di installazione del tool.

Nota

Non sovrascrivere direttamente la cartella di installazione del tool: cancellare quella vecchia e rimpiazzala con quella nuova. Questo farà sì che non rimanga nessun vecchio file.

Se invece è stato usato git, si può mantenere il tool aggiornato dando come comando nella cartella del tool:

$ git fetch
$ git pull

Questo manterrà il tool sul branch stabile master, mentre lo sviluppo attivo procede sul branch testing.

Nota

La cartella di installazione dovrà rimanere pulita per aggiornare in questo modo. Se qualcosa lì dentro è stato cambiato, fare un backup di qualsiasi modifica importante, eseguire git reset --hard HEAD per resettare il tool al suo stato originale e a quel punto aggiornalo con git!

Importante

Indipendentemente dal sistema di aggiornamento scelto, qualsiasi ODKSM.bat o START.bat copiati fuori dalla cartella di installazione del tool avranno bisogno di essere rimpiazzati manualmente con le versioni aggiornate nel caso siano stati cambiati dall’update.

Verifica l’installazione

Per verificare che ODKSM stia funzionando correttamente e che tutte le dipendenze siano soddisfatte, eseguire la test suite con:

$ pipenv run pytest tests/

Tutti i test dovrebbero passare! Siamo pronti ora per creare la prima istanza.