Release/v3.0.0

.github/workflows/python-package.yml

@@ -4,9 +4,6 @@ on:
   push:
     branches:
       - main
-  pull_request:
-    branches:
-      - main
 
 permissions:
   contents: write
@@ -36,6 +33,11 @@ jobs:
       - name: Run tests
         run: |
           uv run pytest
+        env:
+          WFP_API_CLIENT_ID: ${{ secrets.WFP_API_CLIENT_ID }}
+          WFP_API_CLIENT_SECRET: ${{ secrets.WFP_API_CLIENT_SECRET }}
+          DATABRIDGES_VERSION: ${{ secrets.DATABRIDGES_VERSION }}
+          DATABRIDGES_API_KEY: ${{ secrets.DATABRIDGES_API_KEY }}
 
   deploy-docs:
     runs-on: ubuntu-latest
@@ -51,7 +53,7 @@ jobs:
       - name: Install uv and set Python version
         uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b
         with:
-          python-version: "3.12"
+          python-version: "3.13"
       - name: Install dependencies
         run: uv sync --dev
       - name: Deploy documentation

CHANGELOG.md

@@ -1,3 +1,4 @@
+
 ## 2.1.4 (2026-05-19)
 
 ### Fix

Makefile

@@ -23,7 +23,7 @@ check-codestyle:
 .PHONY: codestyle
 codestyle:
 	uv run isort --settings-path pyproject.toml ./
-	uv run black --config pyproject.toml ./
+	uv run black --fast --config pyproject.toml ./
 	uv run ruff check . --fix
 
 #* Tests

README.md

@@ -1,16 +1,27 @@
 # Data Bridges Knots
 
+[![Python package](https://github.com/WFP-VAM/DataBridgesKnots/actions/workflows/python-package.yml/badge.svg)](https://github.com/WFP-VAM/DataBridgesKnots/actions/workflows/python-package.yml)
+
+[![CodeQL](https://github.com/WFP-VAM/DataBridgesKnots/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/WFP-VAM/DataBridgesKnots/actions/workflows/github-code-scanning/codeql)
+
+[![pages-build-deployment](https://github.com/WFP-VAM/DataBridgesKnots/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/WFP-VAM/DataBridgesKnots/actions/workflows/pages/pages-build-deployment)
+
+[![Publish to S3 PyPI](https://github.com/WFP-VAM/DataBridgesKnots/actions/workflows/publish-s3.yml/badge.svg)](https://github.com/WFP-VAM/DataBridgesKnots/actions/workflows/publish-s3.yml)
+
+
 This Python module allows you to get data from the WFP Data Bridges API, including household survey data, market prices, exchange rates, GORP (Global Operational Response Plan) data, and food security data (IPC equivalent). It is a wrapper for the [Data Bridges API Client](https://github.com/WFP-VAM/DataBridgesAPI), providing an easier way to data analysts to get VAM and monitoring data using their language of choice (Python, R and STATA).
 
 ## Getting started
-User guide on the package can be found [here](https://wfp-vam.github.io/DataBridgesKnots/reference/)
+> [!IMPORTANT]
+> User guide on the package can be found [here](https://wfp-vam.github.io/DataBridgesKnots/reference/)
+
 
 ## Installation
 
 ### Using uv
->  :point_right: We recommend using `uv` as package manager. You can install it using the [instructions here](https://docs.astral.sh/uv/getting-started/installation/).
+>  [!TIP] :point_right: We recommend using `uv` as package manager. You can install it using the [instructions here](https://docs.astral.sh/uv/getting-started/installation/).
 
-Install the `data_bridges_knots` package in your environment using uv:
+Install the latest stable `data_bridges_knots` package in your environment using uv:
 
 ```
 uv venv .venv && source .venv/bin/activate && uv pip install data-bridges-knots \
@@ -27,6 +38,14 @@ pip install data-bridges-knots \
 
 STATA and R users will also need the appropriate optional dependencies to use this package in their respective software. To install the package with these dependencies, use the following command:
 
+
+#### Development version
+If you're looking for a specific release/development version, you can install it by running this command, and adding the release number:
+
+```
+ uv pip install git+https://github.com/WFP-VAM/DataBridgesKnots/@release/vX.x.x
+```
+
 ### STATA users
 
 STATA users need to install the `data_bridges_knots` with additional STATA dependencies (`pystata`, and `stata-setup`):
@@ -55,16 +74,12 @@ There are three ways to configure DataBridgesShapes:
 2. The structure of the file is:
 
     ```yaml
-    NAME: ''
-    VERSION : ''
-    KEY: ''
-    SECRET: ''
+    DATABRIDGES_VERSION : ''
+    WFP_API_CLIENT_ID: ''
+    WFP_API_CLIENT_SECRET: ''
     DATABRIDGES_API_KEY: ''
-    SCOPES:
-    - ''
-    - ''
     ```
-3. Replace the placeholders with your actual API key and secret from the Data Bridges API. Update the SCOPES list with the required scopes for your use case.
+3. Replace the placeholders with your actual credentials from the Data Bridges API portal.
 
 ### Option 2: Dictionary Configuration (Recommended for Testing/Programmatic Use)
 
@@ -74,13 +89,9 @@ You can also initialize the client directly with a Python dictionary:
 from data_bridges_knots import DataBridgesShapes
 
 config = {
-    'KEY': 'your-api-key',
-    'SECRET': 'your-api-secret',
-    'VERSION': '7.0.0',
-    'SCOPES': [
-        'vamdatabridges_household-fulldata_get',
-        'vamdatabridges_marketprices-pricemonthly_get'
-    ],
+    'WFP_API_CLIENT_ID': 'your-api-key',
+    'WFP_API_CLIENT_SECRET': 'your-api-secret',
+    'DATABRIDGES_VERSION': 'v1',
     'DATABRIDGES_API_KEY': 'optional-databridges-key'
 }
 
@@ -92,10 +103,9 @@ client = DataBridgesShapes(config)
 Set the following environment variables and use the `config_from_env()` helper:
 
 ```bash
-export DATABRIDGES_KEY="your-api-key"
-export DATABRIDGES_SECRET="your-api-secret"
-export DATABRIDGES_VERSION="7.0.0"
-export DATABRIDGES_SCOPES="scope1,scope2,scope3"
+export WFP_API_CLIENT_ID="your-api-key"
+export WFP_API_CLIENT_SECRET="your-api-secret"
+export DATABRIDGES_VERSION="v1"
 export DATABRIDGES_API_KEY="optional-databridges-key"
 ```
 
@@ -125,7 +135,7 @@ CONFIG_PATH = r"data_bridges_api_config.yaml"
 client = DataBridgesShapes(CONFIG_PATH)
 
 # COMMODITY DATA
-commodity_units_list = client.get_commodity_units_list(country_code="TZA", commodity_unit_name="Kg", page=1, format='json')
+commodity_units_list = client.get_commodity_units_list(country_iso3="TZA", commodity_unit_name="Kg", page=1, format='json')
 
 ```
 Additional examples are in the [examples](https://github.com/WFP-VAM/DataBridgesKnots/tree/main/examples) folder and in the [API Reference document](https://wfp-vam.github.io/DataBridgesKnots/reference/)