Merge pull request #89 from WFP-VAM/release-please--branches--main--components--data-bridges-knots

chore(main): release data-bridges-knots 3.1.0

Author: paololucchino

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "3.0.1"
+  ".": "3.1.0"
 }

CHANGELOG.md

@@ -5,6 +5,104 @@
 - change structure of tests to separate unit from integration testing
 - remove broken redundant tag step from semver workflow
 
+## [3.1.0](https://github.com/WFP-VAM/DataBridgesKnots/compare/data-bridges-knots-v3.0.1...data-bridges-knots-v3.1.0) (2026-05-25)
+
+
+### Features
+
+* add RPME endpoints ([9ef72fc](https://github.com/WFP-VAM/DataBridgesKnots/commit/9ef72fca28096ff7e3588011d8df040e5fa25e6f))
+* **client.py:** Rename auth params and procedure to align with new WFP API Porta (portal.api.wfp.org) ([b1864a0](https://github.com/WFP-VAM/DataBridgesKnots/commit/b1864a0c282a3d7ec141cbd4fed3e3355541aacc))
+* IncubationApi Household Surveys endpoints ([15a7c1d](https://github.com/WFP-VAM/DataBridgesKnots/commit/15a7c1df572a1003a0ec74e718a4f6c96ac49f3b))
+* replace commitizen/semver workflow with Release Please ([af8d64f](https://github.com/WFP-VAM/DataBridgesKnots/commit/af8d64f64a0a77f115329497e99cec70db758774))
+* replace commitizen/semver workflow with Release Please ([bc11802](https://github.com/WFP-VAM/DataBridgesKnots/commit/bc11802364d05e85e1e576cd8528abe224b5dfd5))
+
+
+### Bug Fixes
+
+* add end_date and other optional parameters on get_prices(). Add start_date as replacement to survey_date (backward compatibile) ([e2da0c6](https://github.com/WFP-VAM/DataBridgesKnots/commit/e2da0c6ed057877383cc0dea585c786484e120ba))
+* add mandatory country_iso3 param to get_market_geojson_list, fix  response as geoJSON and add tests for it ([bda09bd](https://github.com/WFP-VAM/DataBridgesKnots/commit/bda09bd9950494dd5f8cfe7e3163531b0a4faaff))
+* add workflow_dispatch to allow manual publish trigger ([3ac8dc1](https://github.com/WFP-VAM/DataBridgesKnots/commit/3ac8dc18fe4e8d3e888d0b4a96b9c91daab563da))
+* change structure of tests to separate unit from integration testing ([1233610](https://github.com/WFP-VAM/DataBridgesKnots/commit/1233610aa9af98af2faf8978d3a362311302c4a9))
+* consolidate examples and country_code for get_commodit_list, get_makrets_list() and get_nearby_markets() ([80e6456](https://github.com/WFP-VAM/DataBridgesKnots/commit/80e6456dcc28e3131ff8b4cc5325e4733cb97f86))
+* consolidate iso3code to adm0 code conversion for all methods ([abb2bfa](https://github.com/WFP-VAM/DataBridgesKnots/commit/abb2bfa2bd2a578e99ffc6535714aa9f554c0584))
+* **DataBridgesShape:** make a fresh call to _setup_configuration_and_authentication() instead of using cached result ([0c6a397](https://github.com/WFP-VAM/DataBridgesKnots/commit/0c6a39730471c414bb4684fe6b35f6d36d95526a))
+* deprecation warning ([8889d94](https://github.com/WFP-VAM/DataBridgesKnots/commit/8889d94410ae26433087bd04966713cc14e30401))
+* Ensure country_is03 is truly optional in get_household_surveys_list ([fb44f65](https://github.com/WFP-VAM/DataBridgesKnots/commit/fb44f65afd383b4e6b51a9c6be55448f5483e66e))
+* Ensure country_is03 is truly optional in get_household_surveys_list ([14d6345](https://github.com/WFP-VAM/DataBridgesKnots/commit/14d634547e9d9250e75c8565de2c939f9a499dbd))
+* examples in docstrings' ([9ae0b9e](https://github.com/WFP-VAM/DataBridgesKnots/commit/9ae0b9ee9afda8818d29d3a95393d1cc7ff709db))
+* failed example on MFI data ([e9c83dd](https://github.com/WFP-VAM/DataBridgesKnots/commit/e9c83dd2087079bf03a05e78fb54fcdb3bb24f2a))
+* get_column_label bug and tests ([caadfb7](https://github.com/WFP-VAM/DataBridgesKnots/commit/caadfb7eb12d38e062b1922a9a9b7af15e455b4a))
+* get_column_labels now can return the output as pd.Dataframe ([8706e22](https://github.com/WFP-VAM/DataBridgesKnots/commit/8706e2266baada52e1de232aed3c525e41b3db8b))
+* get_economic_indicator_list response as data_frame ([c0e4458](https://github.com/WFP-VAM/DataBridgesKnots/commit/c0e445889c2a4551a5a159f25f52c55e60bc87fc))
+* get_household_questionnaire and get_choice_list functions to retrieve correct information ([9db9424](https://github.com/WFP-VAM/DataBridgesKnots/commit/9db9424930126ffbb938531b846a251f58a6f1d4))
+* handle DATA_BRIDGES_API if doesn't exist in config file ([bcb2897](https://github.com/WFP-VAM/DataBridgesKnots/commit/bcb28975e2bce1656d072039b11bcdf92dd74e36))
+* **helpers:** add typing and better naming parameters to get_column_label and get_value_label functions ([e0819b7](https://github.com/WFP-VAM/DataBridgesKnots/commit/e0819b7b34639f8d3533d69244862885d28191bd))
+* host in client ([0382897](https://github.com/WFP-VAM/DataBridgesKnots/commit/0382897251272c2b2ee8f0393aa33bd7ad793e13))
+* import pandas in conftest ([bedadaa](https://github.com/WFP-VAM/DataBridgesKnots/commit/bedadaa60fdf35a401b5f1388b18ddcc783678fe))
+* improve handling of Data Bridges API key ([6c6742f](https://github.com/WFP-VAM/DataBridgesKnots/commit/6c6742f5a01d1324f500ef2134826e9d49b9a481))
+* indentation in .github/workflow ([8f06d70](https://github.com/WFP-VAM/DataBridgesKnots/commit/8f06d70467d88d2be52d84524ac76cf25a3c5943))
+* pd.Dataframe output as long dataset, instead of wide ([69b1f1d](https://github.com/WFP-VAM/DataBridgesKnots/commit/69b1f1db142b69be77c47708e85fce2c00473701))
+* remove broken redundant tag step from semver workflow ([dc8a921](https://github.com/WFP-VAM/DataBridgesKnots/commit/dc8a921ca9fc69ce3d10ab3b588a7929f59fa2f3))
+* remove broken redundant tag step from semver workflow ([0eaa4e1](https://github.com/WFP-VAM/DataBridgesKnots/commit/0eaa4e19affe68ca8b9231dda9ee32a08443f9f2))
+* remove obsolete endpoints ([dc50531](https://github.com/WFP-VAM/DataBridgesKnots/commit/dc5053108ef1393d8aaddf68a37eded36a608695))
+* remove obsolete SCOPES from client ([7116e98](https://github.com/WFP-VAM/DataBridgesKnots/commit/7116e98a4e94627ac6d854800a624b1da2b90a52))
+* remove unused deprecation warning ([ad8f69b](https://github.com/WFP-VAM/DataBridgesKnots/commit/ad8f69b402ad7d4b36473198dd7e32a7eba4e726))
+* rename label functions to more descriptive names ([d96f474](https://github.com/WFP-VAM/DataBridgesKnots/commit/d96f4749cbd921ac7ae3fef477a6436554297870))
+* rename map_label function ([6dab212](https://github.com/WFP-VAM/DataBridgesKnots/commit/6dab212a3bb6a1ada0adf025b161583c7f7bae72))
+* tests for market_geojson ([5fcb941](https://github.com/WFP-VAM/DataBridgesKnots/commit/5fcb941f11df16d5c1f85993749de08594c2b9be))
+* tests work with API call ([86ab458](https://github.com/WFP-VAM/DataBridgesKnots/commit/86ab458d385c3c12489f680972f254755dba8677))
+* trigger version bump to 3.0.1 ([faadc17](https://github.com/WFP-VAM/DataBridgesKnots/commit/faadc172e804d3e0e48bdb64152a055567fd907d))
+* trigger version bump to 3.0.1 ([4334dbe](https://github.com/WFP-VAM/DataBridgesKnots/commit/4334dbe7873b5b44e48177e1e75bfdb4676b910e))
+* typo in python-package.yml ([8d89e3e](https://github.com/WFP-VAM/DataBridgesKnots/commit/8d89e3e83c5a23434a67c793ab46e01bffe48110))
+* update python-package.yml ([074b45e](https://github.com/WFP-VAM/DataBridgesKnots/commit/074b45e04b7d5165ca63e5b5579045ece758ee69))
+
+
+### Performance Improvements
+
+* Cache country codes_mapping to avoid multiple file reads ([082dffd](https://github.com/WFP-VAM/DataBridgesKnots/commit/082dffdc9cc9256da796028089bf552828536f97))
+
+
+### Documentation
+
+* add additional docstrings ([c9a0b56](https://github.com/WFP-VAM/DataBridgesKnots/commit/c9a0b5624618922268a69d079c1bf69ddfbbb05b))
+* add docstrings and typing hints for client.py ([957ef31](https://github.com/WFP-VAM/DataBridgesKnots/commit/957ef31723a84dfbff2a7d8e0d1d750cee300fb2))
+* add examples for household survey and questionnaire ([056588c](https://github.com/WFP-VAM/DataBridgesKnots/commit/056588c96d85d043d013a830b3d9563dc67503a1))
+* add google-docstrings option ([8c9fbbf](https://github.com/WFP-VAM/DataBridgesKnots/commit/8c9fbbf68f3c8c23dfd352ca057fef508b3aeb12))
+* Add instruction on how to use commitizen ([a9a0fa6](https://github.com/WFP-VAM/DataBridgesKnots/commit/a9a0fa659b725c126a47c1f9192c0a1dcec0f2ba))
+* add instructions on using uv ([ad7a0d6](https://github.com/WFP-VAM/DataBridgesKnots/commit/ad7a0d61c3c95c18881ab751b2533d2e54d4fea0))
+* add knots 3.0.0 to pyproject.toml ([a0b21f0](https://github.com/WFP-VAM/DataBridgesKnots/commit/a0b21f0dd6e1d30e903298376ef0babebcce6202))
+* add v3.0.0 CHANGELOG entry ([8adec51](https://github.com/WFP-VAM/DataBridgesKnots/commit/8adec517d05a1d7a3b94607428283979c69f328d))
+* add v3.0.0 CHANGELOG entry ([5827b0b](https://github.com/WFP-VAM/DataBridgesKnots/commit/5827b0bdfefc27744b273ba150f5332e4b5102bd))
+* added Data Bridges API  key from creedential config file ([077cde9](https://github.com/WFP-VAM/DataBridgesKnots/commit/077cde95e2ab900107207f7db7e96d6f8f46e6ae))
+* added documentation ([3c0a759](https://github.com/WFP-VAM/DataBridgesKnots/commit/3c0a75953f90a09a3e733fb2bd7e8fd458f17a0b))
+* configured mkdocs ([f5e326a](https://github.com/WFP-VAM/DataBridgesKnots/commit/f5e326ac1ce48e1877e39191bdc375bf3e534a2f))
+* document label utilities ([9df71fb](https://github.com/WFP-VAM/DataBridgesKnots/commit/9df71fbf88db0f33d79c16ec6f98b1f80098b69f))
+* fix docstrings on get_prices(), get_exchange_rates(), get_food_security_list() and get_gorp() ([72eb59c](https://github.com/WFP-VAM/DataBridgesKnots/commit/72eb59c381f818b01241ba80020779fe9bd73d3b))
+* fix typo ([a8128cd](https://github.com/WFP-VAM/DataBridgesKnots/commit/a8128cd64fa713e89c8c48a4bbb263d6f9fc4cf9))
+* fix typo and add developer setup section ([4474fd3](https://github.com/WFP-VAM/DataBridgesKnots/commit/4474fd3ded03da7097f463e10509da4301ada306))
+* fix typo in README ([f6700a7](https://github.com/WFP-VAM/DataBridgesKnots/commit/f6700a7a7d4aff3ea842c7297b1055cbf17f15ba))
+* fix typo in README ([4f2abb5](https://github.com/WFP-VAM/DataBridgesKnots/commit/4f2abb5359ba8fbd4d6210a8922f80807bb6d9ee))
+* Remove developer information from user-facing docs ([99568dc](https://github.com/WFP-VAM/DataBridgesKnots/commit/99568dc3e6b85148d51272020a71bcff554081a3))
+* rename country_code in country_iso3 in examples ([3123931](https://github.com/WFP-VAM/DataBridgesKnots/commit/3123931338dfedd65f5909e83b65a3116ead453e))
+* update CHANGELOG and ROADMAP ([157ed5b](https://github.com/WFP-VAM/DataBridgesKnots/commit/157ed5b10a747842e6fa5c447fb6b0d3814a09b8))
+* Update docs on new initialization pathways ([67f4c42](https://github.com/WFP-VAM/DataBridgesKnots/commit/67f4c422a2d77add6a4f1ef3d054f824fc4f239b))
+* update documentation ([65c29e3](https://github.com/WFP-VAM/DataBridgesKnots/commit/65c29e3e01392d77980c50981f46d34b7bdef990))
+* update documentation on labelling ([d7d476b](https://github.com/WFP-VAM/DataBridgesKnots/commit/d7d476b6afc5c53e1844996edf57a4086cfe14d6))
+* update example.py with markets endpoint ([b226664](https://github.com/WFP-VAM/DataBridgesKnots/commit/b22666468033947a73243a0f20320912900c0fb6))
+* update mkdocs ([347e7c4](https://github.com/WFP-VAM/DataBridgesKnots/commit/347e7c49b9e08081f02dd1a97a28eb46e9ca8ab3))
+* update README ([705ff01](https://github.com/WFP-VAM/DataBridgesKnots/commit/705ff010532beb2091c4c3b8368fd2072b69a025))
+* update README ([f096162](https://github.com/WFP-VAM/DataBridgesKnots/commit/f0961621c7cedcd98df2d38ee28878212ec65157))
+* update README ([5dbdaa6](https://github.com/WFP-VAM/DataBridgesKnots/commit/5dbdaa6465a9ddfd7e883f0b5208d3d7fd2e6abd))
+* update README and remove obsolete examples ([f8447a5](https://github.com/WFP-VAM/DataBridgesKnots/commit/f8447a56c858f4ec5a8fe5ac777bd586d141506c))
+* update README file and pyproject.toml ([078cd05](https://github.com/WFP-VAM/DataBridgesKnots/commit/078cd0512db65156b2e6b57763076667368fa3ca))
+* update README to reflect change in API version ([fd10205](https://github.com/WFP-VAM/DataBridgesKnots/commit/fd102056236be348ac3f2801c37a3d9b38372482))
+* update README to reflect change in API version ([07060df](https://github.com/WFP-VAM/DataBridgesKnots/commit/07060dfcc254a52a0f70d3d999df074884479878))
+* update README with API Reference document ([e3d2892](https://github.com/WFP-VAM/DataBridgesKnots/commit/e3d289230e258aa8b589085c35ffd1b64e243350))
+* update README with examples ([b80ec1d](https://github.com/WFP-VAM/DataBridgesKnots/commit/b80ec1df87ccf40849ac860c8089853a16579379))
+* update README with installation instructions ([ba9821f](https://github.com/WFP-VAM/DataBridgesKnots/commit/ba9821fa0a4cd3ccc90cb6081128ab3ba61afb70))
+* updated installation instructions with uv ([4dc8816](https://github.com/WFP-VAM/DataBridgesKnots/commit/4dc881635377717e60e0ee21214d4d76650c18c0))
+* updated README example ([90f7758](https://github.com/WFP-VAM/DataBridgesKnots/commit/90f77588da8a4ed70394c83ff142c0d4167e548e))
+
 ## v3.0.0 (2026-05-22)
 
 ### BREAKING CHANGE

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "data_bridges_knots"
-version = "3.0.1"
+version = "3.1.0"
 authors = [{ name = "Alessandra Gherardelli", email = "alessandra.gherardelli@wfp.org" }, {name = "Valerio Giuffrida", email = "valerio.giuffrida@wfp.org"}]
 description = "Multi programming language wrapper for WFP Data Bridges API client"
 readme = "README.md"