diff --git a/INSTALL.md b/INSTALL.md index c86ea45..2714882 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -23,46 +23,73 @@ ### Configurer l'application +Les fichiers de configuration fournis dans le répertoire ./resources sont à copier à la racine du projet, +mais peuvent être laissés tels quels pour un premier test aprés installation. + +Il est bon d'y jeter un oeil, les commentaires sont là pour aider. + # D'abord les accès base de donnée - cp resources/pdc_config.py . - $(EDITOR) pdc_config.py + # cp resources/db_config.py . $(EDITOR) db_config.py - # Ensuite l'application elle même (ce fichier est utilisable tel quel) - cp resources/flaskenv .flaskenv + # Puis le fichier pour l'application elle même + # + cp resources/pdc_config.py . + $(EDITOR) pdc_config.py + + # Enfin le contrôle de la commande flask + # également chargé par l'application grace à l'instruction: + # app/__init__.py: load_dotenv(env_file, verbose=True) + # + cp resources/flaskenv .flaskenv # ! noter le '.' devant le fichier destination $(EDITOR) .flaskenv ### Créer la base de données -Utiliser l'outil de ligne de commande fourni avec l'application. +Dans un premier temps pour tester l'installation, on peut s'appuyer sur une base déjà disponible. - flask pdc_db --help +Il s'agit de l'import d'une base de type Lesia dont les noms d'agents, de projets, de métiers et de services ont été +réécrit avec des chantiers du batiment. Cela afin de ne pas diffuser des données réelles du Lesia et permettre la +diffusion de ces données de test avec le projet plan-de-charge. + + cp resources/lesia-btp.sqlite ./pdc-dev.db + +Vérifier que ce chemin correspond avec celui configuré dans le fichier `db_config.py` - # créer la structure de la base +Pour un usage plus avancé, il y a l'outil de ligne de commande fourni avec l'application. + + # Créer la structure de la base + # flask pdc_db create_db - # renseigner des agent depuis une base type lesia + # Il est aussi possible d'importer une base de type Lesia + # cela suppose de disposer d'une telle base, et de l'avoir configurée dans db_config.py + # flask pdc_db feed_from_lesia - # entrer des périodes - # ( inutile s'il y a eu un import Lesia) - flask pdc_db feed_periods + # Voire de l'anonymiser: + # + flask pdc_db fake_lesia_names - # entrer des charges aléatoires (une centaine) - # ( inutile s'il y a eu un import Lesia) - flask pdc_db feed_random_charges + # Plus d'info sur les outils en ligne de commande: + # + flask --help + flask pdc_db --help ## Jouer les tests et exécuter un serveur local pip install -r requirements-tests.txt + cp resources/lesia-btp.sqlite ./pdc-test.db # ou le chemin configuré dans `db_config.py` PYTHONPATH=. pytest # éventuellement voir le taux de couverture + # PYTHONPATH=. pytest --cov=app --cov-report=xml:"coverage.xml" --cov-report=term --junitxml "tests-report.xml" - # ouvrir un serveur sur localhost:5000 +Enfin, ouvrir un serveur sur localhost:5000 et y accéder avec son navigateur. + flask run ## Configurer l'appli web avec apache @@ -70,6 +97,7 @@ Utiliser l'outil de ligne de commande fourni avec l'application. ### Les fichiers concernés: - pdc_web.wsgi +- pdc_web.py - pdc_config.py - db_config.py @@ -143,4 +171,4 @@ Normalement, cette configuration permet de lire les variables positionées dans FLASK_APP=pdc_web -Ainsi fait, exécutez votre projet depuis pycharm et testez. +Ainsi fait, exécutez votre projet depuis pycharm et essayez sur un navigateur à l'adresse localhost:5000. -- libgit2 0.21.2