Le marché de l'inclusion est un service numérique permettant de trouver un prestataire sociale inclusif proposant des produits ou services professionnels.
Voici un tableau explicatif de la nomenclature utilisée dans le code (par rapport à l'application)
| Dans le métier | Dans le code |
|---|---|
| Appel d'offres | Tender |
| Demande de devis | Quote |
| Sourcing | Project |
| Liste de favoris | Favorite list |
| Structure | Siae |
| Utilisateur | User |
| Réseau | Network |
| Demande de rattachement | User request |
| Prestation | Offer |
| Référence client | Client reference |
| Label & certification | Label |
| Secteur d'activité | Sector |
| Groupe de secteurs d'activité | Sector group |
| Périmètre | Perimeter |
Étapes d'une installation en local à des fins de développement. L'environnement fourni permet de fonctionner de 3 manières différentes :
- Poetry + Postgres (sans Docker)
- Dockerfile + Postgres
- docker-compose (installe tout l'environnement nécessaire)
Pour un déploiement local sans Docker, dupliquez le fichier env.default.sh en env.local.sh et apportez-y les modifications nécessaires.
$ cp env.default.sh env.local.sh
# Préparation de l'environnement local
$ source ./env.local.shPrérequis :
- packets python à installer : poetry, python3.9, python3.9-dev, default-libmysqlclient-dev
- initialiser une db Postgres (ne pas oublier l'extension PostGIS)
Installation et exécution :
> Installation environnement Python
$ poetry install
> Configuration environnement
$ source ./env.local.sh
> Exécution
$ poetry run python manage.py runserver
$ poetry run python manage.py [COMMANDES]
> Avec surcharge `PYTHONPATH` (à résoudre)
$ env PYTHONPATH=./lemarche:./lemarche/c4_directory poetry run python manage.py [COMMANDES]L'application utilise un Dockerfile multistage, permettant de fonctionner en "Dev" et "Prod" avec le même Dockerfile.
Pour l'environnement de développement, un docker-compose est fourni (voir ci-dessous).
Pour la configuration Django, vérifiez le fichier config/settings/dev.py.
Pour un déploiement local avec Docker, dupliquez le fichier env.docker_default.local en env.docker.local et apportez-y les modifications nécessaires (bien que la plupart des paramètres devraient fonctionner hors de la boîte).
ℹ️ pour accéder à l'environnemnt depuis une autre machine, pensez à définir la variable d'environnemnt
CURRENT_HOSTdans le fichier d'environnement
Après création du fichier env.docker.local :
# Démarrage
> docker-compose up
# Après démarrage, le serveur est disponible sur http://localhost:8880/
# Se connecter au containeur django
> docker exec -it bitoubi_django /bin/bash
# ou
> make shell_on_django_container
# Re-création de l'environnement (en cas de modification)
> docker-compose down
> docker-compose build --no-cache
> docker-compose up --force-recreate
# Effacement complet des images dockers
> ./scripts/delete_docker.shLe script start_docker.sh permet de lancer les environnements en local, en mode dev ou prod :
> ./start_docker.sh -h
-p|--prod run full docker (Prod config)
-d|--dev run dev docker (Dev config and local mounts)
# Pour lancer l'environnement de développement
> ./start_docker.sh --devUne fois lancé, l'application est disponible sur http://localhost:8880/.
Le dépôt de besoin utilise les périmètres. Il est possible de les charger avec les commandes Django :
django-admin import_regions
django-admin import_departements
django-admin import_communesDes données de test peuvent être chargées ainsi (fixtures) :
ls -d lemarche/fixtures/django/* | xargs django-admin loaddataIl y a aussi une API, qui propose plusieurs endpoints et interfaces de documentation :
Tant que faire se peut, la documentation des endpoints se fait dans le code, en visant une bonne lisibilité de la documentation autogénérée.
Le projet centralise ses dépendances dans le fichier pyproject.toml.
Poetry utilise le fichier poetry.lock, et une commande permet de générer le fichier requirements.txt.
(c'est ce choix qui motive l'utilisation de pflake8 et poethepoet).
# Mise à jour dépendances
$ poetry update
# Mise à jour requirements/staging.txt
$ poetry run poe export
# Mise à jour requirements/dev.txt
$ poetry run poe export_devEt pour connaître les dépendances à mettre à jour :
$ poetry show --outdatedSi l'environnement est neuf ou n'est plus à jour, appliquez les migrations nécessaires :
# Avec manage.py
$ poetry run python manage.py makemigrations
$ poetry run python manage.py migrateLe repo suit le workflow par branche de fonctionnalité, et un versionnage sémantique.
Mettre en place le pre-commit :
poetry run pre-commit install
poetry run pre-commit runLe projet utilise flake8, isort et black pour assurer la standardisation des écritures. Poetry est configuré pour en faciliter l'utilisation.
# Exécuter isort, flake8 ou black, avec poetry
$ poetry run poe black
$ poetry run poe isort
$ poetry run poe flake8
# Exécuter formattage automatique
$ poetry run poe clean_code
# Exécuter formattage automatique dans le docker
$ poe clean_codePyTest & Selenium sont utilisés pour ce projet.
Les tests se trouvent dans les fichiers tests.py ou les répertoires tests (un sous-répertoire par app django)
Pour lancer les tests :
poetry run python manage.py test
# pour lancer un lot de tests en particulier
poetry run python manage.py test -- lemarche.api.siaes.tests.SiaeListApiTestMode direct (sans task queue) :
export CONNECTION_MODE_TASKS="direct"
Mode redis :
export CONNECTION_MODE_TASKS="redis"
Mode sqlite :
export CONNECTION_MODE_TASKS="sqlite"
Mode redis :
export CONNECTION_MODE_TASKS="redis"
1/ Lancer un serveur local 2/ Dans un autre shell lancer la commande
/manage.py run_huey
Ajouter la variable d'environnement suivante sur la config clever cloud :
CC_WORKER_COMMAND=django-admin run_huey