update readme

InseeFrLab · Nov 20, 2024 · 3143055 · 3143055
1 parent 11d5761
commit 3143055
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 1 deletion.
diff --git a/python-package/cartiflette/README.md b/python-package/cartiflette/README.md
@@ -39,6 +39,27 @@ data = carti_download(
 )
 ```
 
+Si besoin de passer par un proxy, il faut déclarer http_proxy et https_proxy en variable d'environnement. Par exemple :
+``` python
+import os
+
+from cartiflette.client import carti_download
+
+os.environ["http_proxy"] = yourproxy
+os.environ["https_proxy"] = yourproxy
+
+data = carti_download(
+    values = ["France"],
+    crs = 4326,
+    borders = "DEPARTEMENT",
+    vectorfile_format="topojson",
+    simplification=50,
+    filter_by="FRANCE_ENTIERE_DROM_RAPPROCHES",
+    source="EXPRESS-COG-CARTO-TERRITOIRE",
+    year=2022
+)
+```
+
 ## Contexte
 
 Le projet `cartiflette` est un projet collaboratif lancé par des agents de l'Etat dans le cadre d'un programme interministériel

diff --git a/python-package/cartiflette/pyproject.toml b/python-package/cartiflette/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cartiflette"
-version = "0.1.4"
+version = "0.1.5"
 description = "Tools to easily retrieve French borders for geographic data analytics"
 authors = ["Lino Galiana <[email protected]>", "Thomas Grandjean <[email protected]>", "Alica Burlot <[email protected]>"]
 license = "OPEN LICENCE 2.0/LICENCE OUVERTE 2.0"