new catalog module using Melodi API

.github/workflows/examples.yml

@@ -30,8 +30,7 @@ jobs:
 
     - name: Test all examples
       env:
-        insee_key: ${{ secrets.INSEE_KEY }}
-        insee_secret: ${{ secrets.INSEE_SECRET }}
+        sirene_key: ${{ secrets.SIRENE_KEY }}
       run: |
         pip install jupytext
         pip install .[full] 
@@ -48,8 +47,7 @@ jobs:
 
     - name: Test idbank list download
       env:      
-        insee_key: ${{ secrets.INSEE_KEY }}
-        insee_secret: ${{ secrets.INSEE_SECRET }}
+        sirene_key: ${{ secrets.SIRENE_KEY }}
       run: |     
         pip install . 
         python -c "from pynsee.macrodata._dwn_idbank_files import _dwn_idbank_files;_dwn_idbank_files()"

.github/workflows/pkgTests.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
     - uses: actions/checkout@v2
@@ -22,7 +22,7 @@ jobs:
       run: |
         #sudo apt-get install libgeos-dev
         python -m pip install --upgrade pip
-        pip install flake8 pytest pytest-cov geopandas nbconvert matplotlib descartes 
+        pip install flake8 pytest pytest-cov geopandas nbconvert matplotlib descartes parameterized 
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
         if [ -f requirements-extra.txt ]; then pip install -r requirements-extra.txt; fi
     - name: Lint with flake8
@@ -33,8 +33,7 @@ jobs:
         flake8 . --count --ignore=E722,C901 --exit-zero --max-complexity=10 --max-line-length=127 --statistics
     - name: Test examples
       env:
-        insee_key: ${{ secrets.INSEE_KEY }}
-        insee_secret: ${{ secrets.INSEE_SECRET }}
+        sirene_key: ${{ secrets.SIRENE_KEY }}
       run: |
         pip install jupytext
         pip install -r requirements.txt
@@ -48,8 +47,7 @@ jobs:
         cd ../..
     - name: Test with pytest
       env:      
-        insee_key: ${{ secrets.INSEE_KEY }}
-        insee_secret: ${{ secrets.INSEE_SECRET }}
+        sirene_key: ${{ secrets.SIRENE_KEY }}
       run: |
         pytest -v --cov
     - name: "Upload coverage to Codecov"

.github/workflows/pkgTests_pull_requests.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
 
     steps:
     - uses: actions/checkout@v4
@@ -24,7 +24,7 @@ jobs:
       run: |
         #sudo apt-get install libgeos-dev
         python -m pip install --upgrade pip
-        pip install flake8 pytest pytest-cov geopandas nbconvert matplotlib descartes 
+        pip install flake8 pytest pytest-cov geopandas nbconvert matplotlib descartes parameterized
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
         if [ -f requirements-extra.txt ]; then pip install -r requirements-extra.txt; fi
     - name: Lint with flake8
@@ -35,8 +35,7 @@ jobs:
         flake8 . --count --ignore=E722,C901 --exit-zero --max-complexity=10 --max-line-length=127 --statistics
     - name: Test examples
       env:
-        insee_key: ${{ secrets.INSEE_KEY }}
-        insee_secret: ${{ secrets.INSEE_SECRET }}
+        sirene_key: ${{ secrets.SIRENE_KEY }}
       run: |
         pip install jupytext
         pip install -r requirements.txt
@@ -50,8 +49,7 @@ jobs:
         cd ../..
     - name: Test with pytest
       env:      
-        insee_key: ${{ secrets.INSEE_KEY }}
-        insee_secret: ${{ secrets.INSEE_SECRET }}
+        sirene_key: ${{ secrets.SIRENE_KEY }}
       run: |
         pytest -v --cov
     - name: "Upload coverage to Codecov"

.github/workflows/release.yml

@@ -20,7 +20,7 @@ jobs:
       matrix:
         os: [ubuntu-20.04]
         #[ubuntu-20.04, windows-2019, macOS-10.15]
-        python-version: ["3.8"]
+        python-version: ["3.12"]
         #["3.7", "3.8", "3.9", "3.10"]
 
     steps:

NEWS.md

@@ -1,4 +1,10 @@
 
+# pynsee 0.1.9
+* new API portal: portail-api.insee.fr
+* no token generation is needed anymore, only a key is needed to use SIRENE API
+* backend function update in the utils module + sirene functions update
+* subsequent doc and test update
+
 # pynsee 0.1.8
 
 * sirene module compatible with SIRENE API v3.11

README.md

@@ -13,16 +13,14 @@
 a dozen datasets of local data, numerous sources available on [insee.fr](https://www.insee.fr), 
 geographical limits of administrative areas taken from IGN
 as well as key metadata and SIRENE database containing data on all French companies.
-Have a look at the detailed API page [api.insee.fr](https://api.insee.fr/catalogue/).
+Have a look at the detailed API page [portail-api.insee.fr](https://portail-api.insee.fr/).
 
 This package is a contribution to reproducible research and public data transparency. 
 It benefits from the developments made by teams working on APIs at INSEE and IGN.
 
 ## Installation & API subscription
 
-The files available on [insee.fr](https://www.insee.fr) and IGN data, i.e. the use of `download` and `geodata` modules, do not require authentication.
-Credentials are necessary to access some of the INSEE APIs available through `pynsee` by the modules `macrodata`, `localdata`, `metadata` and `sirene`. 
-API credentials can be created here : [api.insee.fr](https://api.insee.fr/catalogue/)
+Credentials are necessary to access SIRENE API available through `pynsee` by the module `sirene`. API credentials can be created here : [portail-api.insee.fr](https://portail-api.insee.fr/). All other modules are freely accessible.
 
 ```python
 
@@ -34,10 +32,10 @@ pip install pynsee[full]
 # cd pynsee
 # pip install .[full]
 
-# Subscribe to api.insee.fr and get your credentials!
+# Subscribe to portail-api.insee.fr and get your credentials!
 # Save your credentials with init_conn function :      
 from pynsee.utils.init_conn import init_conn
-init_conn(insee_key="my_insee_key", insee_secret="my_insee_secret")
+init_conn(sirene_key="my_sirene_key")
 
 # Beware : any change to the keys should be tested after having cleared the cache
 # Please do : from pynsee.utils import clear_all_cache; clear_all_cache()
@@ -61,7 +59,7 @@ For further advice, have a look at the documentation and gallery of the [example
 ## Example - Population Map
 
 <h1 align="center">
-<img src="https://raw.githubusercontent.com/InseeFrLab/pynsee/master/docs/_static/popfrance.png?token=AP32AXOVNXK5LWKM4OJ5THDAZRHZK">
+<img src="https://raw.githubusercontent.com/InseeFrLab/pynsee/master/docs/_static/popfrance.png">
 </h1>
 
 ```python
@@ -145,8 +143,7 @@ fig.savefig('pop_france.svg',
 
 # Use the proxy_server argument of the init_conn function to change the proxy server address   
 from pynsee.utils.init_conn import init_conn
-init_conn(insee_key="my_insee_key",
-         insee_secret="my_insee_secret",
+init_conn(sirene_key="my_sirene_key",
          http_proxy="http://my_proxy_server:port",
          https_proxy="http://my_proxy_server:port")
 
@@ -156,8 +153,7 @@ init_conn(insee_key="my_insee_key",
 # Alternativety you can use directly environment variables as follows. 
 # Beware not to commit your credentials!
 import os
-os.environ['insee_key'] = 'my_insee_key'
-os.environ['insee_secret'] = 'my_insee_secret'
+os.environ['sirene_key'] = 'my_sirene_key'
 os.environ['http_proxy'] = "http://my_proxy_server:port"
 os.environ['https_proxy'] = "http://my_proxy_server:port"
 

docs/api_subscription.rst

@@ -1,13 +1,13 @@
 .. role:: raw-html(raw)
     :format: html
 
-Have a look at the official tutorial on `api.insee.fr <https://api.insee.fr/catalogue/site/themes/wso2/subthemes/insee/pages/help.jag>`_
+Have a look at the official tutorial on `portail-api.insee.fr <https://api.insee.fr/catalogue/site/themes/wso2/subthemes/insee/pages/help.jag>`_
 
 
 API Subscription Tutorial
 =========================
 
-#. Create an account on api.insee.fr
+#. Create an account on portail-api.insee.fr
 
 #. Create an application
 
@@ -52,7 +52,7 @@ API Subscription Tutorial
    # Subscribe to api.insee.fr and get your credentials!
    # Save your credentials with init_conn function :      
    from pynsee.utils.init_conn import init_conn
-   init_conn(insee_key="my_insee_key", insee_secret="my_insee_secret")
+   init_conn(sirene_key="my_sirene_key")
 
    # Beware : any change to the keys should be tested after having cleared the cache
    # Please do : from pynsee.utils import clear_all_cache; clear_all_cache()