tpl-python

Un template pour un projet Python.

Prérequis

• Un interpréteur Python (version >= 3.8)
  • en juin 2020 : 3.7 (Debian/stable), 3.8 (Debian/testion), 3.5 (Ubuntu/16.04), 3.6 (Ubuntu/18.04), 3.8 (Ubuntu/20.04), 3.8 (Windows/python.org), 3.8 (Mac OS X/python.org), 3.7/3.8 (Anaconda/Miniconda/tous systèmes), 3.8 (python.org/tous systèmes)
• Le gestionnaire de paquets Python pip
  • la distribution Python de python.org à partir de la version 3.4 contient pip
• Le module venv pour la gestion des environnements virtuels (tutoriel)
  • Le module venv existe dans la bibliothèque standard Python depuis la version 3.3
• Un IDE
  • par exemple, Visual Studio Code avec l'extension Microsoft Python extension (tutoriel)

Remarques

• Les distributions Python de python.org ou Anaconda/Miniconda fournissent de base l'ensemble des prérequis Python.
• L'installation de base de la distribution Anaconda contient l'IDE Spyder et les notebooks Jupyter. Ce n'est pas le cas de Miniconda qui est beaucoup plus légère (400 Mo contre 3 Go).
• L'installation de paquet python avec pip peut provoquer une compilation et donc nécessiter des outils adéquats sur la machine. Ce n'est pas le cas avec Anaconda/Miniconda.

Préparation initiale du projet

Les étapes de cette section ne sont à effectuer qu'une fois lors de la création du projet local.

Cloner le dépôt

git clone https://github.com/hal91190/tpl-python.git projet

Il est préférable de forker au préalable le projet dans son espace github personnel pour ensuite le cloner. Cela permet par la suite de valider les modifications ce qui n'est pas possible sur le projet original à cause des droits d'accès.

Création et activation de l'environnement

• Avec la distribution python.org

  python3 -m venv .venv
  source .venv/bin/activate

• Avec la distribution Anaconda/Miniconda

  conda env create
  conda activate envpython

Installation des dépendances

• Avec la distribution python.org

  pip install -r requirements.txt

• Avec la distribution Anaconda/Miniconda

  L'installation des dépendances est faite en même temps que la création de l'environnement.

Utilisation courante du projet

Activation de l'environnement

• Avec la distribution python.org

  source .venv/bin/activate

• Avec la distribution Anaconda/Miniconda

  conda activate envpython

Exécuter un programme

• Hello

  python3 exercises/hello/hello.py

• explot (test de matplotlib)

  python3 exercises/explot/explot.py

• Kata Fizzbuzz (avec tests unitaires)

  python3 exercises/fizzbuzz/test_fizzbuzz.py
  python3 exercises/fizzbuzz/fizzbuzz.py

Validez un programme

flake8 exercises/fizzbuzz/fizzbuzz.py
mypy exercises/fizzbuzz/fizzbuzz.py

Notes sur Visual Studio Code/Microsoft Python extension

• Pour sélectionner l'interpréteur ou l'environnement Python adéquat, il faut ouvrir la Command Palette (Ctrl+Shift+P), puis taper Python: Select Interpreter.
• Pour ouvrir un REPL Python dans l'environnement courant, il faut ouvrir la Command Palette (Ctrl+Shift+P), puis taper Python: Start REPL.
• Pour ouvrir un terminal dans l'environnement courant, il faut ouvrir la Command Palette (Ctrl+Shift+P), puis taper Terminal: Create New Integrated Terminal.

Notes sur le projet

Cette section contient des notes sur la façon dont le projet a été créé. Ces actions ne sont pas à reproduire lors de l'usage du projet.

Création et activation

• Avec la distribution python.org

  python3 -m venv .venv
  source .venv/bin/activate

• Avec la distribution Anaconda/Miniconda

  conda create -name envpython
  conda activate envpython
  conda install numpy matplotlib jupyter

Installation des linters (flake8, mypy)

• Avec la distribution python.org

  pip install flake8
  pip install mypy

• Avec la distribution Anaconda/Miniconda

  conda install flake8 mypy

Sauvegarder l'environnement

• Avec la distribution python.org

  pip freeze > requirements.txt

• Avec la distribution Anaconda/Miniconda

  conda env export --name envpython > environment.yml