2021-12-01 23:08:54 +00:00
Title: Tuto : script durable en Python
2021-04-22 23:05:19 +00:00
Date: 2021-04-23 00:44
2021-12-01 23:08:54 +00:00
Modified: 2021-12-02 00:19
Summary: Python est livré avec les piles, profitons-en.
2021-04-22 23:05:19 +00:00
Category: Réalisations
2021-12-01 23:08:54 +00:00
Tags: forga, cli, python, git, dry, gitlab, agile, tuto, méthode, collectif, dev
2021-12-01 23:22:01 +00:00
Status: published
2021-04-22 23:05:19 +00:00
Slug: tuto-script-durable-python-stdlib
2021-12-01 23:08:54 +00:00
💡 C'est quoi l'idée ?
2021-04-22 23:05:19 +00:00
=====================
2021-12-01 23:08:54 +00:00
Un guide de construction d'un script python CLI robuste et maintenable même plusieurs mois après l'avoir laissé de côté! Python est [_livré avec les piles_][py-batteries], profitons-en et utilisons pour ça :
2021-04-22 23:05:19 +00:00
2021-12-01 23:08:54 +00:00
- les tests : [`doctest`][doctest]
- les logs : [`logging`][logging]
- les arguments de la CLI : [`argparse`][argparse]
2021-04-22 23:05:19 +00:00
2021-12-01 23:08:54 +00:00
C'est le 1er tuto dans la liste [_«Parcours de tutorat»_][forga-emb], _Un script durable en Python_ .
2021-04-22 23:05:19 +00:00
2021-12-01 23:08:54 +00:00
Plus de détails dans ma proposition de réalisation :
2021-04-22 23:05:19 +00:00
2021-12-01 23:08:54 +00:00
- [le ticket associé][pysdur-issue]
- [les commits][pysdur-commit]
2021-04-22 23:05:19 +00:00
2021-12-01 23:08:54 +00:00
🌐 Quel est le contexte ?
========================
2021-04-22 23:05:19 +00:00
2021-12-01 23:08:54 +00:00
Le groupe [`forga`][forga] a pour objectif de proposer une organisation facilitant :
2021-04-22 23:05:19 +00:00
2021-12-01 23:08:54 +00:00
- ♻️ la réutilisation de code
- 📝 la documentation (de code ou d'autre chose)
- 🤝 la collaboration
2021-04-22 23:05:19 +00:00
2021-12-01 23:08:54 +00:00
Ce groupe à été brièvement abordé dans une [présentation][meetup-forga] pour le groupe _GitLab FR_ .
2021-04-22 23:05:19 +00:00
2021-12-01 23:08:54 +00:00
🤝 Merci qui ?
==============
2021-04-22 23:05:19 +00:00
2021-12-01 23:08:54 +00:00
_Vincent Bernat_ pour son billet de blog dont je me suis complètement inspiré :
2021-04-22 23:05:19 +00:00
2021-12-01 23:08:54 +00:00
* [🇫🇷 _Écrire un script Python durable_ ](https://vincent.bernat.ch/fr/blog/2019-script-python-durable )
* [🇬🇧 _Writing sustainable Python scripts_ ](https://vincent.bernat.ch/en/blog/2019-sustainable-python-script )
2021-04-22 23:05:19 +00:00
2022-09-15 22:02:56 +00:00
[meetup-forga]: {filename}/afpy-lyon-2019-11-devel-orga.md
2021-12-01 23:08:54 +00:00
[forga-emb]: https://gitlab.com/forga/process/fr/embarquement
[pysdur-issue]: https://gitlab.com/forga/process/fr/embarquement/-/issues/6
[pysdur-commit]: https://gitlab.com/free_zed/mypsb/-/commits/tuto-pysdur
[forga]: https://gitlab.com/forga/
[doctest]: https://docs.python.org/3/library/doctest.html
[logging]: https://docs.python.org/3/library/logging.html
[argparse]: https://docs.python.org/3/library/argparse.html
[py-batteries]: https://docs.python.org/3/tutorial/stdlib.html#batteries-included