Skip to content

Migrate to Poetry

Ticket was about migrating to Pipenv. Now it is for Poetry

Migrate from setup.{py,cfg}, requirements_{,dev,deploy}.txt, and Makefile to pyproject.toml and poetry.lock.

Advantages

  • migrate dependencies from three files to one pyproject.toml which is supported by the Python project
  • lock file: poetry.lock
  • Makefile rules migrated to pyproject.toml in order to have a central file
  • Will be able to use own built Docker images with poetry inside, and run matrix test for supported Python versions
  • Poetry can build and publish to PyPi out of the box. wheel and twine are hidden under the hood. Nice for CI/CD and new contributors.
  • History

Inconvenient


Tasks

  • Migrate setup.{py,cfg} and requirements_{,dev,deploy}.txtto pyproject.toml
  • Do not commit poetry.lock for a libraryreason
    • Add poetry.lock into the .gitignore with a comment explaining why
  • Consider !91 (merged) in the pyproject.toml: attr/attrs
  • Clean sphinx extra stuff (in pyproject.toml and .gitlab-ci.yml).
  • Have black installable with Python ≥ 3.6
  • Update Makefile rules
  • Update release.sh
  • Update CI
  • Document poetry usage, update documentation

To be done later

Edited by Moul
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information