## Faire ses paquets En respectant les standards.
## Donc on va parler de distutils ? PEP 632 (septembre 2020) : Deprecate distutils module. La doc dit de ne plus l'utiliser depuis ~2014…
## Donc on va parler de {buzzword} ? - pipenv : 304k lignes de code. - bento : 37k lignes de code. - poetry : 16k lignes de code. - flit : 4k lignes de code. - build : <1k lignes de code.
## Non mais pourquoi pas {buzzword} ? - Ça demande du temps pour migrer d'un standard à un outil tiers. - Ça demande à une partie de l'équipe d'apprendre ce nouvel outil. - Puis ça demande du temps pour migrer à nouveau vers le standard quand l'outil est abandonné.
## Mais les Pipfile ? En fait oui et non, Pipfile c'est une spec à part : => https://github.com/pypa/pipfile Rien n'empêche d'un jour pouvoir faire un : ``` pip install --pipfile Pipfile.lock ```
## OK, bon, comment on fait sans buzzwords ?
## pyproject.toml Les PEP 517 et 518 normalisent la construction de paquets en déclarant son outil de build dans `pyproject.toml` : ```toml [build-system] requires = ["setuptools", "wheel"] build-backend = "setuptools.build_meta" ``` Le backend étant `setuptools.build_meta`, on aura besoin d'un `setup.cfg`.
## setup.py En 2020 il ne prenait plus qu'une ou deux lignes, bienvenu en 2021.
## setup.cfg ``` [metadata] name = oeis version = attr: oeis.__version__ description = Implementation of a few integer sequences. long_description = file: README.md long_description_content_type = text/markdown; charset=UTF-8 ... ```
## Vous venez de 2020 ? Ne faites pas la conversion à la main ! ```text pip install setup-py-upgrade ```
## Comment je build ? On peut utiliser `build` de la PyPA, un outil qui ne fait qu'une chose mais qui le fait bien : ``` pip install build python -m build --sdist --wheel . ```
## Et comment j'upload ? On peut utiliser `twine` de la PyPA, un outil qui ne fait qu'une chose mais qui le fait bien : ```text pip install twine twine upload -r test dist/* pip install --index-url https://test.pypi.org/simple/ oeis twine upload dist/* ```
## Et les dépendances !? Les dépendances « runtime » (`install_requires`) sont décrites dans le `setup.cfg`.
## Épinglées ou pas ? Ça dépend de ce que vous faites, mais généralement on vise le plus large possible.
## Épingler saybien ! Je n'ai pas dit que c'était mal, c'est très bien pour les développeurs, pour la CI, pour la prod…
## Épingler saybien ! J'utilise un outil qui ne fait qu'une chose mais qui le fait bien : `pip-compile` du paquet `pip-tools`, ça ne fait *que* geler les dépendances, et ça le fait bien.
## Épingler saybien ! On peut donc "geler" les dépendances du projet via un : ``` pip-compile setup.py ```
## Épingler saybien ! On peut ensuite documenter ses dépendances de dev dans un `requirements-dev.in` : ```txt -r requirements.txt tox ```
## Épingler saybien ! Et épingler aussi les requirements de dev, afin de les utiliser dans des tests reproductibles : ```txt pip-compile requirements-dev.in ```
## Épingler saybien ! On peut même hasher les dépendances pour les plus paranos : ```txt pip-compile --generate-hashes setup.py ```
## Qu'est-ce que ça donne ? ``` pyproject.toml // 3 lignes setup.cfg requirements.txt // autogénéré par pip-compile requirements-dev.in requirements-dev.txt // autogénéré par pip-compile ```
## Mettre à jour ```txt pip-compile --upgrade requirements-dev.in ```
## Installer Il existe un outil qui ne fait qu'une chose, mais qui le fait bien : `pip`. ``` pip install oeis ```
## Installer Vous connaissez alors je passe sur le plus gros, mais n'oubliez pas : ```txt pip install git+https://github.com/org/project@branch ```
## RTFM - https://setuptools.readthedocs.io/en/latest/build_meta.html - https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html - https://packaging.python.org/guides/using-testpypi/ - https://setuptools.readthedocs.io/en/latest/setuptools.html#setup-cfg-only-projects
## Questions ?