Librairies ROK4 Python

Ces librairies facilitent la manipulation d'entités du projet ROK4 comme les Tile Matrix Sets, les pyramides ou encore les couches, ainsi que la manipulation des stockages associés.

Installer la librairie

Installations système requises :

• debian : apt install python3-rados python3-gdal

Depuis PyPI : pip install rok4

Depuis GitHub : pip install https://github.com/rok4/core-python/releases/download/x.y.z/rok4-x.y.z-py3-none-any.whl

L'environnement d'exécution doit avoir accès aux librairies système. Dans le cas d'une utilisation au sein d'un environnement python, précisez bien à la création python3 -m venv --system-site-packages .venv.

Utiliser la librairie

from rok4.tile_matrix_set import TileMatrixSet

try:
    tms = TileMatrixSet("file:///path/to/tms.json")
except Exception as exc:
    print(exc)

Les variables d'environnement suivantes peuvent être nécessaires, par module :

• storage : plus de détails dans la documentation technique du module
  • ROK4_READING_LRU_CACHE_SIZE : Nombre d'élément dans le cache de lecture (0 pour ne pas avoir de limite)
  • ROK4_READING_LRU_CACHE_TTL : Durée de validité d'un élément du cache, en seconde (0 pour ne pas avoir de limite)
  • ROK4_CEPH_CONFFILE : Fichier de configuration du cluster Ceph
  • ROK4_CEPH_USERNAME : Compte d'accès au cluster Ceph
  • ROK4_CEPH_CLUSTERNAME : Nom du cluster Ceph
  • ROK4_S3_KEY : Clé(s) de(s) serveur(s) S3
  • ROK4_S3_SECRETKEY : Clé(s) secrète(s) de(s) serveur(s) S3
  • ROK4_S3_URL : URL de(s) serveur(s) S3
  • ROK4_SSL_NO_VERIFY : Désactivation de la vérification SSL pour les accès S3 (n'importe quelle valeur non vide)
• tile_matrix_set :
  • ROK4_TMS_DIRECTORY : Dossier racine (fichier ou objet) des tile matrix sets
• style :
  • ROK4_STYLES_DIRECTORY : Dossier racine (fichier ou objet) des styles

Readings uses a LRU cache system with a TTL. It's possible to configure it with environment variables :

• ROK4_READING_LRU_CACHE_SIZE : Number of cached element. Default 64. Set 0 or a negative integer to configure a cache without bound. A power of two make cache more efficient.
• ROK4_READING_LRU_CACHE_TTL : Validity duration of cached element, in seconds. Default 300. 0 or negative integer to get cache without expiration date.

To disable cache (always read data on storage), set ROK4_READING_LRU_CACHE_SIZE to 1 and ROK4_READING_LRU_CACHE_TTL to 1.

Using CEPH storage requires environment variables :

Using S3 storage requires environment variables :

Plus d'exemple dans la documentation développeur.

Contribuer

• Installer les dépendances de développement :

  python3 -m pip install -e .[dev]
  pre-commit install

• Consulter les directives de contribution

Compiler la librairie

apt install python3-venv python3-rados python3-gdal
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install --upgrade build bump2version
bump2version --current-version 0.0.0 --new-version x.y.z patch

# Run unit tests
python3 -m pip install -e .[test]
# To use system installed modules rados and osgeo
echo "/usr/lib/python3/dist-packages/" >.venv/lib/python3.10/site-packages/system.pth
python3 -c 'import sys; print (sys.path)'
# Run tests
coverage run -m pytest
# Get tests report and generate site
coverage report -m
coverage html -d dist/tests/

# Build documentation
python3 -m pip install -e .[doc]
pdoc3 --html --output-dir dist/ rok4

# Build artefacts
python3 -m build

Remarque :

Lors de l'installation du paquet apt python3-gdal, une dépendance, peut demander des interactions de configuration. Pour installer dans un environnement non-interactif, définir la variable shell DEBIAN_FRONTEND=noninteractive permet d'adopter une configuration par défaut.

Publier la librairie sur Pypi

Configurer le fichier $HOME/.pypirc avec les accès à votre compte PyPI.

python3 -m pip install --upgrade twine
python3 -m twine upload --repository pypi dist/rok4-x.y.z-py3-none-any.whl dist/rok4-x.y.z.tar.gz