python_management

Setup a complete python virtual environment

Description

Ensure that python required version is installed. If yes, ensure that pip3 is installed too. If yes, create and activate a python virtual environment, install basic python module wheel and pip-tools. Then depending on the value requirements_type check if corresponding requirements files are provided, if there is no requirements file with pinned version compile a pinned version of the requirements. Finally install python requirements.

If everything above as already been done in a previous activation of the directory environment, simply activate the python virtual environment.

If anything goes wrong, like wrong python version, pip3 not installed, etc., print an error

Parameters in .envrc.ini are:

Parameters

python_version

Main minimum python version required to be installed. For instance, if python v3.8.10 is required, main python version is 3.

python_release

Minimum python release required to be installed. For instance, if python v3.8.10 is required, python release is 8.

python_patch

Minimum python patch required to be installed. For instance, if python v3.8.10 is required, python patch is 10.

requirements_type

Define which requirement.*.in and requirement.*.txt to be processed. Possible values are:

• dev (default), will process following files:
  • requirements.dev.*: Contain unpinned (.in) and pinned (.txt) python dependencies used for development purpose.
  • requirements.docs.*: Contain unpinned (.in) and pinned (.txt) python dependencies used for documentation purpose.
  • requirements.prod.*: Contain unpinned (.in) and pinned (.txt) python dependencies used for production purpose.
• docs (default), will process following files:
  • requirements.docs.*: Contain unpinned (.in) and pinned (.txt) python dependencies used for documentation purpose.
• prod, will process following files:
  • requirements.prod.*: Contain unpinned (.in) and pinned (.txt) python dependencies used for production purpose.

.envrc.ini example

Corresponding entry in .envrc.ini.template are:

# Python management module
# ------------------------------------------------------------------------------
# Manage python virtual environment and ensure python binaries
[python_management]
# Main python version, to ensure python binaries installed have right version
# If not set, default is 3
python_version=3
# Main python release, to ensure python binaries installed have right release
# If not set, default is 8
python_release=8
# Main python patch, to ensure python binaries installed have right patch
# If not set, default is 0
python_patch=0
# Specify which requirements to install, either :
#   - `prod`: Only install requirements.prod.txt
#   - `docs`: Only install requirements.docs.txt
#   - `dev`: Install all requirements.*.txt
# Default is dev
requirements_type=dev