Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to poetry for dependencies management #1219

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

fabienheureux
Copy link
Member

@fabienheureux fabienheureux commented Jan 15, 2025

Description succincte du problème résolu

https://www.notion.so/accelerateur-transition-ecologique-ademe/La-gestion-des-d-pendances-ne-semble-pas-optimale-1596523d57d7807a91b7d9eaa85ff139?pvs=4

Ça tourne sur https://dashboard.scalingo.com/apps/osc-fr1/quefairedemesobjets-preprod/deploy/baf37131-258f-4af8-a506-b1c023c58ac7

Utilisation de Poetry ✍️

Désormais toutes les installations de dépendance, gestion d'environnement virtuel, déploiements passent par poetry.

Intérêt (voir https://www.notion.so/accelerateur-transition-ecologique-ademe/Synchronisation-des-Techos-1756523d57d78090be2df64e55e29142?pvs=4#17c6523d57d780b8a399cab5b559beb0)

  • Un lockfile qui fixe les dépendances
  • Une résolution des dépendances à l'installation qui vérifie les contraintes de version et empêche l'installation de dépendances incompatibles

Dependabot 🤖

à tester sur le moyen / long terme, mais je crois que dependabot va uniquement mettre à jour le poetry.lock.
On est donc pas exemptés de mettre à jour les versions majeures manuellement dans le pyproject si on souhaite fixer une version spécifique.

CI 🏗️

Tout est fonctionnel et testé

Déploiements 🚀

Scalingo supporte les poetry.lock, j'ai testé un déploiement en staging et on est bon ! 🎉

Docker 🐳

J'en ai profité pour assainir les dockerfile :

  • Utilisation de multi stage builds https://docs.docker.com/build/building/multi-stage/
  • On a donc plusieurs étapes
    • build des dépendances système (gdal)
    • build / installation des dépendances python
    • runtime
  • modernisation de l'installation de awscli
  • build de psycopg2 plutôt qu'utilisation de psycopg2 binary

On copie le contenu de chaque étape de build dans le runtime.
Les avantages

  • On embarque pas de compilateur C etc en prod : images plus légères, risques de sécurité réduits...entre autres

En local

Idéalement il faudrait que vous réinitialisiez votre environnement local pour qu'on soit sûr de l'absence d'effets de bords

  • Installation de Poetry
  • Suppression de l'environnement virtuel
  • Re-création via poetry

TODO

  • Mettre à jour le readme
  • Mettre à jour les Dockerfile

Type de changement :

  • Bug fix
  • Nouvelle fonctionnalité
  • Mise à jour de données / DAG
  • Les changements nécessitent une mise à jour de documentation
  • Refactoring de code (explication à retrouver dans la description)

Auto-review

Les trucs à faire avant de demander une review :

  • J'ai bien relu mon code
  • La CI passe bien
  • En cas d'ajout de variable d'environnement, j'ai bien mis à jour le .env.template
  • J'ai ajouté des tests qui couvrent le nouveau code

@fabienheureux fabienheureux force-pushed the switch-to-poetry-for-dependencies branch 3 times, most recently from b2fd62f to 62fbec4 Compare January 15, 2025 15:04
@fabienheureux fabienheureux marked this pull request as ready for review January 15, 2025 15:21
@fabienheureux fabienheureux requested a review from a team as a code owner January 15, 2025 15:21
@fabienheureux fabienheureux requested review from kolok and maxcorbeau and removed request for a team January 15, 2025 15:21
.github/workflows/run_tests.yml Outdated Show resolved Hide resolved
@fabienheureux fabienheureux force-pushed the switch-to-poetry-for-dependencies branch 2 times, most recently from 83b32aa to d50bdc2 Compare January 16, 2025 14:20
Copy link
Contributor

@maxcorbeau maxcorbeau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK donc si je comprends bien:

  • CI: on préfixe les commandes de build avec poetry (pour que poetry charge son environnement et éxecute ce qui suit)
  • poetry.toml: conf de base poetry
  • pyproject.toml: c'est maintenant là qu'on vient définir les différents requirements
  • *requirements.in/txt: tout ça dégage 🥳
  • Dockerfile: petites modifs pour intégrer poetry

J'ai manqué un truc important?

Peux-tu stp faire un résumé des commandes à utiliser au quotidien? (le workflow standard)

pyproject.toml Outdated Show resolved Hide resolved
@fabienheureux fabienheureux force-pushed the switch-to-poetry-for-dependencies branch from d3dc731 to 42b9fc4 Compare January 16, 2025 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants