Skip to content

Commit d2fac70

Browse files
pre-commit-ci[bot]Dolite
authored andcommitted
Homogénéisation des fichiers
- passage du CHANGELOG au format keepachangelog - déplacement des fichiers de tests dans les dossiers fixtures - migration de fix-encoding-pragma vers pyupgrade dans le pre commit
1 parent f80928d commit d2fac70

11 files changed

Lines changed: 66 additions & 55 deletions

.pre-commit-config.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,16 @@ repos:
1414
- id: detect-private-key
1515
- id: end-of-file-fixer
1616
- id: fix-byte-order-marker
17-
- id: fix-encoding-pragma
18-
args: [--remove]
1917
- id: name-tests-test
2018
args: [--pytest-test-first]
2119
- id: trailing-whitespace
2220
args: [--markdown-linebreak-ext=md]
2321

22+
- repo: https://github.com/asottile/pyupgrade
23+
rev: v3.21.2
24+
hooks:
25+
- id: pyupgrade
26+
2427
- repo: https://github.com/astral-sh/ruff-pre-commit
2528
rev: "v0.12.2"
2629
hooks:

CHANGELOG.md

Lines changed: 54 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,86 @@
1-
## 2.2.3
1+
# Changelog
22

3-
### [Changed]
3+
Tous les changements sont consignés dans ce fichier.
44

5-
* Module `storage` : il est possible de l'utiliser sans avoir la librairie GDAL : seule la fonction `get_osgeo_path` pour du S3 ne sera pas disponible
5+
Le format est basé sur [Keep a Changelog](https://keepachangelog.com/) et ce projet respecte le [Semantic Versioning](https://semver.org/).
6+
7+
## [Unreleased]
68

7-
## 2.2.0
9+
### Added
10+
### Changed
11+
### Deprecated
12+
### Removed
13+
### Fixed
814

9-
### [Added]
15+
## [2.2.3] - 2024-10-01
16+
17+
### Changed
18+
19+
* Module `storage` : il est possible de l'utiliser sans avoir la librairie GDAL : seule la fonction `get_osgeo_path` pour du S3 ne sera pas disponible
20+
21+
### Added
1022

1123
* Ajout de la librairie de gestion d'un style ROK4
1224

13-
## 2.1.5
25+
## [2.1.5] - 2024-04-29
1426

15-
### [Changed]
27+
### Changed
1628

1729
* Pyramid : la fonction de chargement de la liste en mémoire retourne le nombre de dalle
1830

19-
## 2.1.4
31+
## [2.1.4] - 2024-02-13
2032

21-
### [Fixed]
33+
### Fixed
2234

2335
* Storage : la réponse à un HEAD (test existence en S3) donne un code 404 et non NoSuchKey (confusion avec la lecture d'objet)
2436
* RasterSet: le chargement d'un raster set à partir d'un fichier ou d'un descripteur utilise la librairie Storage et non la librairie GDAL
2537

26-
## 2.1.3
38+
## [2.1.3] - 2024-02-08
2739

28-
### [Fixed]
40+
### Fixed
2941

3042
* Storage : dans le cas d'une lecture ou d'un test existence sur un objet S3 absent, le code dans la réponse n'est pas 404 mais NoSuchKey
3143

32-
## 2.1.0
33-
34-
### [Added]
44+
### Added
3545

3646
* Pyramid
3747
* Ajout de fonctions pour récupérer la tile_limits et le nombre de canaux de cette pyramide
3848
* Ajout de fonctions pour ajouter ou supprimer des niveaux dans une pyramide
3949
* TileMatrixSet
4050
* Ajout de fonctions pour récupérer la hauteur et la largeur de tuiles d'un TileMatrixSet
4151

42-
### [Changed]
52+
### Changed
4353

4454
* Pyramid
4555
* Ajout d'un paramètre optionnel "mask" pour le constructeur from other afin de pouvoir conserver ou non les masques de la pyramide servant de base à la nouvellle
4656
* Gestion des documentations des différentes versions avec l'outil [mike](https://github.com/jimporter/mike)
4757

48-
## 2.0.1
58+
## [2.0.1] - 2023-10-09
4959

50-
### [Added]
60+
### Added
5161

5262
* `storage` : le cache de lecture est configurable en taille (avec ROK4_READING_LRU_CACHE_SIZE) et en temps de rétention (avec ROK4_READING_LRU_CACHE_TTL)
5363

54-
### [Security]
64+
### Security
5565

5666
* Montée de version de pillow (faille de sécurité liée à libwebp)
5767

58-
## 2.0.0
68+
## [2.0.0] - 2023-09-26
5969

60-
### [Fixed]
70+
### Fixed
6171

6272
* Pyramid
6373
* quand on lit une tuile dans une pyramide PNG 1 canal, on retourne bien aussi un numpy.array à 3 dimensions (la dernière dimension sera bien un array à un élément)
6474

65-
### [Changed]
75+
### Changed
6676

6777
* Storage
6878
* Le client S3 garde ouverte des connexions
6979
* La fonction get_data_binary a un système de cache de type LRU, avec un temps de validité de 5 minutes
7080

71-
## 1.7.1
81+
## [1.7.1] - 2023-07-10
7282

73-
### [Added]
83+
### Added
7484

7585
* Raster
7686
* Classe RasterSet, réprésentant une collection d'objets de la classe Raster, avec des informations supplémentaires
@@ -88,7 +98,7 @@
8898
* Ajout de la copie de HTTP vers FILE/S3/CEPH
8999
* Ajout de la fonction de lecture d'un fichier HTTP, de l'existence d'un fichier HTTP et du calcul de taille d'un fichier HTTP
90100

91-
### [Changed]
101+
### Changed
92102

93103
* Raster
94104
* Homogénéisation du code
@@ -100,41 +110,41 @@
100110
* Mise en conformité PEP-8 des fonctions `compute_bbox` et `compute_format`
101111

102112

103-
### [Fixed]
113+
### Fixed
104114

105115
* Utils
106116
* Correction d'un nom de variable dans la fonction `compute_format`, qui écrasait une fonction du noyau python.
107117

108118

109119

110-
## 1.6.0
120+
## [1.6.0] - 2023-03-20
111121

112122
Lecture par système de fichier virtuel avec GDAL
113123

114-
### [Added]
124+
### Added
115125

116126
* Storage
117127
* Fonction `get_osgeo_path` permettant de configurer le bon sytème de fichier virtuel en fonction du chemin fourni, et retourne celui à utiliser dans le Open de gdal ou ogr
118128

119-
### [Changed]
129+
### Changed
120130

121131
* Storage
122132
* la récupération d'un client S3 (`__get_s3_client`) permet de récupérer le client, l'hôte, les clés d'accès et secrète, ainsi que le nom du bucket sans l'éventuel hôte du cluster
123133

124-
### [Fixed]
134+
### Fixed
125135

126136
* Storage
127137
* Lecture binaire S3 : mauvaise configuration du nom du bucket et de l'objet et mauvaise lecture partielle
128138

129-
### [Removed]
139+
### Removed
130140

131141
* Exceptions
132142
* `NotImplementedError` est une exceptions native
133143

134144

135-
## 1.5.0
145+
## [1.5.0] - 2023-03-17
136146

137-
### [Added]
147+
### Added
138148

139149
* Level
140150
* Fonction de test d'une tuile `is_in_limits` : ses indices sont ils dans les limites du niveau ?
@@ -146,19 +156,19 @@ Lecture par système de fichier virtuel avec GDAL
146156
* Meilleure gestion de reprojection par `reproject_bbox` : on détecte des systèmes identiques en entrée ou quand seul l'ordre des axes changent, pour éviter le calcul
147157
* Ajout de la fonction de reprojection d'un point `reproject_point` : on détecte des systèmes identiques en entrée ou quand seul l'ordre des axes changent, pour éviter le calcul
148158

149-
### [Changed]
159+
### Changed
150160

151161
* Utils :
152162
* `bbox_to_geometry` : on ne fournit plus de système de coordonnées, la fonction se content de créer la géométrie OGR à partir de la bbox, avec éventuellement une densification en points des bords
153163
* Pyramid :
154164
* Renommage de fonction : `update_limits` -> `set_limits_from_bbox`. Le but est d'être plus explicite sur le fonctionnement de la fonction (on écrase les limites, on ne les met pas juste à jour par union avec la bbox fournie)
155165

156166

157-
## 1.4.4
167+
## [1.4.4] - 2023-03-10
158168

159169
Ajout de fonctionnalités de lecture de donnée d'une pyramide et suivi des recommandations PyPA pour la gestion du projet.
160170

161-
### [Added]
171+
### Added
162172

163173
* TileMatrix :
164174
* Fonction de calcul des indices de tuile et de pixel dans la tuile à partir d'un point dans le système de coordonnées du TMS
@@ -171,7 +181,7 @@ Ajout de fonctionnalités de lecture de donnée d'une pyramide et suivi des reco
171181

172182
* Ajout de la publication PyPI dans la CI GitHub
173183

174-
### [Changed]
184+
### Changed
175185

176186
* Storage :
177187
* La lecture sous forme de chaîne s'appuie sur la lecture complète binaire. Aucun changement à l'usage.
@@ -180,11 +190,11 @@ Ajout de fonctionnalités de lecture de donnée d'une pyramide et suivi des reco
180190
* Passage de la configuration du projet dans le fichier `pyproject.toml`
181191

182192

183-
## 1.3.0
193+
## [1.3.0] - 2023-02-27
184194

185195
Ajout de la librairie de lecture de données vecteur, de tests unitaires et ajout de fonctionnalité pour le stockage. Amélioration de la gestion du projet et de l'intégration continue.
186196

187-
### [Added]
197+
### Added
188198

189199
* Librairie de lecture de données vecteur :
190200
* Chargement de données vecteur pour des fichiers shapefile, Geopackage, CSV et GeoJSON
@@ -200,11 +210,11 @@ Ajout de la librairie de lecture de données vecteur, de tests unitaires et ajou
200210
* Compilation de la documentation et publication sur la branche gh-pages
201211

202212

203-
## 1.2.0
213+
## [1.2.0] - 2023-01-27
204214

205215
Ajout des librairies pour l'utilitaire make-layer.py
206216

207-
### [Added]
217+
### Added
208218

209219
* Librairie Storage : complétion des tests unitaires
210220

@@ -226,21 +236,21 @@ Ajout des librairies pour l'utilitaire make-layer.py
226236
* Configuration de l'outil coverage pour voir la couverture des tests unitaires
227237

228238

229-
## 1.1.0
239+
## [1.1.0] - 2023-01-13
230240

231241
Prise en charge de plusieurs clusters S3 de stockage.
232242

233-
### [Added]
243+
### Added
234244

235245
* Librairie d'abstraction du stockage :
236246
* Prise en charge de plusieurs clusters S3. Les variables d'environnement pour le stockage S3 précisent plusieurs valeurs séparées par des virgules, et les noms des buckets peuvent être suffixés par "@{S3 cluster host}". Par défaut, le premier cluster défini est utilisé. L'hôte du cluster n'est jamais écrit dans le descripteur de pyramide ou le fichier liste (puisque stockés sur le cluster, on sait sur lequel sont les objets). Les objets symboliques ne le précisent pas non plus et ne peuvent être qu'au sein d'un cluster S3
237247

238248

239-
## 1.0.0
249+
## [1.0.0] - 2022-11-30
240250

241251
Initialisation des librairies Python utilisées par les outils python à venir du dépôt [pytools](https://github.com/rok4/pytools).
242252

243-
### [Added]
253+
### Added
244254

245255
* Librairie d'abstraction du stockage (S3, CEPH ou FILE)
246256
* récupération du contenu sous forme de string

CONTRIBUTING.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,32 +10,30 @@ Voir le fichier de configuration correspondant : `.pre-commit-config.yaml`.
1010

1111
## Pull request
1212

13-
Le titre de la PR est utilisé pour constituer automatiquement les notes de release. Vous pouvez préciser en commentaire de votre PR des détails qui seront ajoutés dans le fichier `CHANGELOG.md` par les mainteneurs du projet.
14-
15-
Le formalisme du changelog est le suivant, en markdown :
13+
Complétez le fichier `CHANGELOG.md`, dans la partie `[Unreleased]`, en précisant les modifications fonctionnelles apportées. Celles ci seront utilisées pour rédiger le message de release sur GitHub. Le format est basé sur [Keep a Changelog](https://keepachangelog.com/). Les sections sont les suivantes :
1614

1715
```md
18-
### [Added]
16+
### Added
1917

2018
Liste de nouvelles fonctionnalités.
2119

22-
### [Changed]
20+
### Changed
2321

2422
Liste de fonctionnalités existantes modifiées.
2523

26-
### [Deprecated]
24+
### Deprecated
2725

2826
Liste de fonctionnalités dépréciées.
2927

30-
### [Removed]
28+
### Removed
3129

3230
Liste de foncitonnalités retirées.
3331

34-
### [Fixed]
32+
### Fixed
3533

3634
Liste de corrections fonctionnelles.
3735

38-
### [Security]
36+
### Security
3937

4038
Liste de corrections de sécurité.
4139
```
File renamed without changes.

0 commit comments

Comments
 (0)