Merge pull request #91 from rok4/develop

Release 2.2.0

Author: Dolite

.github/labeler.yml

@@ -1,21 +1,33 @@
 ci-cd:
-  - .github/**/*
+- changed-files:
+  - any-glob-to-any-file:
+    - .github/**
 
 dependencies:
-  - requirements.txt
-  - requirements/*.txt
+- changed-files:
+  - any-glob-to-any-file:
+    - requirements.txt
+    - requirements/*.txt
 
 documentation:
-  - docs/**/*
+- changed-files:
+  - any-glob-to-any-file:
+    - docs/**
 
 enhancement:
-  - src/**/*
+- changed-files:
+  - any-glob-to-any-file:
+    - src/**
 
 quality:
-  - tests/**/*
+- changed-files:
+  - any-glob-to-any-file:
+    - tests/**
 
 tooling:
-  - .gitignore
-  - .pre-commit-config.yaml
-  - setup.cfg
-  - pyproject.toml
+- changed-files:
+  - any-glob-to-any-file:
+    - .gitignore
+    - .pre-commit-config.yaml
+    - setup.cfg
+    - pyproject.toml

.github/workflows/build-and-release.yaml

@@ -185,7 +185,7 @@ jobs:
 
     steps:
       - name: Remove release and tag
-        uses: dev-drprasad/delete-tag-and-release@v1.0.1
+        uses: dev-drprasad/delete-tag-and-release@v1.1
         with:
           tag_name: ${{ github.ref_name }}
           delete_release: true

.github/workflows/pr-auto-labeler.yml

@@ -2,14 +2,11 @@ name: "🏷 PR Labeler"
 on:
   - pull_request
 
-permissions:
-  contents: read
-  pull-requests: write
-
 jobs:
-  triage:
+  labeler:
+    permissions:
+      contents: read
+      pull-requests: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/labeler@v5
-        with:
-          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+    - uses: actions/labeler@v5

.pre-commit-config.yaml

@@ -2,7 +2,7 @@ exclude: ".venv|__pycache__|tests/dev/|tests/fixtures/"
 fail_fast: false
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: check-added-large-files
         args: ["--maxkb=1024"]
@@ -22,13 +22,13 @@ repos:
         args: [--markdown-linebreak-ext=md]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.3.4"
+    rev: "v0.5.0"
     hooks:
       - id: ruff
         args: ["--fix-only", "--target-version=py38"]
 
   - repo: https://github.com/psf/black
-    rev: 24.3.0
+    rev: 24.4.2
     hooks:
       - id: black
         args: ["--target-version=py38"]
@@ -40,7 +40,7 @@ repos:
         args: ["--profile", "black", "--filter-files"]
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.15.2
+    rev: v3.16.0
     hooks:
       - id: pyupgrade
         args:

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.2.0
+
+### [Added]
+
+* Ajout de la librairie de gestion d'un style ROK4
+
 ## 2.1.5
 
 ### [Changed]

README.md

@@ -27,6 +27,33 @@ 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.
 
 

README.pypi.md

@@ -24,4 +24,21 @@ except Exception as exc:
     print(exc)
 ```
 
+Following environment variables could be used, by module :
+
+* `storage` : more details in the module developer documentation
+    * `ROK4_READING_LRU_CACHE_SIZE` : Cache size (0 for no limit)
+    * `ROK4_READING_LRU_CACHE_TTL` : Cache validity time (0 for no limit)
+    * `ROK4_CEPH_CONFFILE` : Ceph configuration file
+    * `ROK4_CEPH_USERNAME` : Ceph cluster user
+    * `ROK4_CEPH_CLUSTERNAME` : Ceph cluster name
+    * `ROK4_S3_KEY` : Key(s) for S3 server(s)
+    * `ROK4_S3_SECRETKEY` : Secret key(s) for S3 server(s)
+    * `ROK4_S3_URL` : URL(s) for S3 server(s)
+    * `ROK4_SSL_NO_VERIFY` : Disable SSL conrols for S3 access (any non empty value)
+* `tile_matrix_set` :
+    * `ROK4_TMS_DIRECTORY` : Root directory (file or object) for tile matrix sets
+* `style` :
+    * `ROK4_STYLES_DIRECTORY` : Root directory (file or object) for styles
+
 More examples in the developer documentation

src/rok4/storage.py

@@ -1,6 +1,7 @@
 """Provide functions to read or write data
 
 Available storage types are :
+
 - S3 (path are preffixed with `s3://`)
 - CEPH (path are prefixed with `ceph://`)
 - FILE (path are prefixed with `file://`, but it is the default paths' interpretation)
@@ -10,17 +11,20 @@
 According to functions, all storage types are not necessarily available.
 
 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 :
+
 - ROK4_CEPH_CONFFILE
 - ROK4_CEPH_USERNAME
 - ROK4_CEPH_CLUSTERNAME
 
 Using S3 storage requires environment variables :
+
 - ROK4_S3_KEY
 - ROK4_S3_SECRETKEY
 - ROK4_S3_URL