hdx-python-api 6.5.6__tar.gz → 6.6.0__tar.gz

{hdx_python_api-6.5.6 → hdx_python_api-6.6.0}/.pre-commit-config.yaml

@@ -2,13 +2,13 @@ default_language_version:
     python: python3.13
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-ast
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.12.0
+    rev: v0.14.10
     hooks:
       # Run the linter.
       - id: ruff-check
@@ -16,10 +16,11 @@ repos:
       # Run the formatter.
       - id: ruff-format
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.7.14
+    rev: 0.9.22
     hooks:
       # Run the pip compile
       - id: pip-compile
         name: pip-compile requirements.txt
         files: pyproject.toml
-        args: [ pyproject.toml, --resolver=backtracking, --all-extras, --upgrade, -q, -o, requirements.txt ]
+        args: [ pyproject.toml, --resolver=backtracking, --upgrade, -q,
+                -o, requirements.txt ]

{hdx_python_api-6.5.6 → hdx_python_api-6.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hdx-python-api
-Version: 6.5.6
+Version: 6.6.0
 Summary: HDX Python API for interacting with the Humanitarian Data Exchange
 Project-URL: Homepage, https://github.com/OCHA-DAP/hdx-python-api
 Author: Michael Rans
@@ -24,12 +24,12 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Requires-Dist: ckanapi>=4.8
 Requires-Dist: defopt>=7.0.0
 Requires-Dist: email-validator
-Requires-Dist: hdx-python-country>=3.9.8
-Requires-Dist: hdx-python-utilities>=3.9.6
+Requires-Dist: hdx-python-country>=4.0.0
+Requires-Dist: hdx-python-utilities>=4.0.0
 Requires-Dist: libhxl>=5.2.2
 Requires-Dist: makefun
 Requires-Dist: quantulum3

{hdx_python_api-6.5.6 → hdx_python_api-6.6.0}/documentation/index.md

@@ -54,6 +54,10 @@ The library has detailed API documentation which can be found in the menu at the
 
 
 ## Breaking Changes
+From 6.6.0, Python 3.10 or later is required
+
+From 6.5.7, get_size_and_hash moved to HDX Python Utilities
+
 From 6.5.2, remove unused `generate_qc_resource_from_rows` method.
 `generate_resource_from_rows`, `generate_resource_from_iterable` and
 `download_and_generate_resource` are deprecated. They are replaced by
@@ -906,6 +910,12 @@ corresponding id and that resource on HDX will be overwritten.
 
     resource.create_in_hdx(dataset=DATASET)
 
+Alternatively, if a resource doesn't have an id, but contains a package_id, the create
+and update methods will use it to load the corresponding dataset, the resource will be
+assigned to that dataset and it will be compared to resources in that dataset. If a
+match is found, then the resource will be given the corresponding id and that resource
+on HDX will be overwritten.
+
 You can download a resource using the **download** function eg.
 
     url, path = resource.download("FOLDER_TO_DOWNLOAD_TO")

{hdx_python_api-6.5.6 → hdx_python_api-6.6.0}/hatch.toml

@@ -34,4 +34,4 @@ run = """
 
 [envs.hatch-static-analysis]
 config-path = "none"
-dependencies = ["ruff==0.12.0"]
+dependencies = ["ruff==0.14.10"]

{hdx_python_api-6.5.6 → hdx_python_api-6.6.0}/pyproject.toml

@@ -31,14 +31,14 @@ classifiers = [
     "Operating System :: MacOS",
     "Operating System :: Microsoft :: Windows",
 ]
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 
 dependencies = [
     "ckanapi>=4.8",
     "defopt>=7.0.0",
     "email_validator",
-    "hdx-python-country>=3.9.8",
-    "hdx-python-utilities>=3.9.6",
+    "hdx-python-country>=4.0.0",
+    "hdx-python-utilities>=4.0.0",
     "libhxl>=5.2.2",
     "makefun",
     "quantulum3",

{hdx_python_api-6.5.6 → hdx_python_api-6.6.0}/requirements.txt

@@ -1,25 +1,15 @@
 # This file was autogenerated by uv via the following command:
-#    uv pip compile pyproject.toml --resolver=backtracking --all-extras -o requirements.txt
+#    uv pip compile pyproject.toml --resolver=backtracking -o requirements.txt
 annotated-types==0.7.0
     # via pydantic
-astdoc==1.3.2
-    # via mkapi
 attrs==25.4.0
     # via
     #   frictionless
     #   jsonlines
     #   jsonschema
     #   referencing
-babel==2.17.0
-    # via mkdocs-material
-backrefs==6.1
-    # via mkdocs-material
-cachetools==6.2.4
-    # via google-auth
-certifi==2025.11.12
+certifi==2026.1.4
     # via requests
-cfgv==3.5.0
-    # via pre-commit
 chardet==5.2.0
     # via frictionless
 charset-normalizer==3.4.4
@@ -27,53 +17,31 @@ charset-normalizer==3.4.4
 ckanapi==4.9
     # via hdx-python-api (pyproject.toml)
 click==8.3.1
-    # via
-    #   mkdocs
-    #   typer
-colorama==0.4.6
-    # via mkdocs-material
-coverage==7.13.0
-    # via pytest-cov
+    # via typer
 defopt==7.0.0
     # via hdx-python-api (pyproject.toml)
-distlib==0.4.0
-    # via virtualenv
 dnspython==2.8.0
     # via email-validator
 docopt==0.6.2
     # via
     #   ckanapi
     #   num2words
-docutils==0.22.3
+docutils==0.22.4
     # via defopt
 email-validator==2.3.0
     # via hdx-python-api (pyproject.toml)
 et-xmlfile==2.0.0
     # via openpyxl
-filelock==3.20.1
-    # via virtualenv
 frictionless==5.18.1
     # via hdx-python-utilities
-ghp-import==2.1.0
-    # via mkdocs
-google-auth==2.45.0
-    # via
-    #   google-auth-oauthlib
-    #   gspread
-google-auth-oauthlib==1.2.2
-    # via gspread
-gspread==6.2.1
-    # via hdx-python-api (pyproject.toml)
-hdx-python-country==3.9.8
+hdx-python-country==4.0.0
     # via hdx-python-api (pyproject.toml)
-hdx-python-utilities==3.9.6
+hdx-python-utilities==4.0.0
     # via
     #   hdx-python-api (pyproject.toml)
     #   hdx-python-country
-humanize==4.14.0
+humanize==4.15.0
     # via frictionless
-identify==2.6.15
-    # via pre-commit
 idna==3.11
     # via
     #   email-validator
@@ -82,21 +50,15 @@ ijson==3.4.0.post0
     # via hdx-python-utilities
 inflect==7.5.0
     # via quantulum3
-iniconfig==2.3.0
-    # via pytest
 isodate==0.7.2
     # via frictionless
 jinja2==3.1.6
-    # via
-    #   frictionless
-    #   mkapi
-    #   mkdocs
-    #   mkdocs-material
+    # via frictionless
 jsonlines==4.0.0
     # via hdx-python-utilities
 jsonpath-ng==1.7.0
     # via libhxl
-jsonschema==4.25.1
+jsonschema==4.26.0
     # via
     #   frictionless
     #   tableschema-to-template
@@ -110,105 +72,39 @@ loguru==0.7.3
     # via hdx-python-utilities
 makefun==1.16.0
     # via hdx-python-api (pyproject.toml)
-markdown==3.10
-    # via
-    #   mkdocs
-    #   mkdocs-material
-    #   pymdown-extensions
 markdown-it-py==4.0.0
     # via rich
-marko==2.2.1
+marko==2.2.2
     # via frictionless
 markupsafe==3.0.3
-    # via
-    #   jinja2
-    #   mkdocs
+    # via jinja2
 mdurl==0.1.2
     # via markdown-it-py
-mergedeep==1.3.4
-    # via
-    #   mkdocs
-    #   mkdocs-get-deps
-mkapi==4.5.0
-    # via hdx-python-api (pyproject.toml)
-mkdocs==1.6.1
-    # via
-    #   mkapi
-    #   mkdocs-material
-mkdocs-get-deps==0.2.0
-    # via mkdocs
-mkdocs-material==9.7.0
-    # via mkapi
-mkdocs-material-extensions==1.3.1
-    # via mkdocs-material
 more-itertools==10.8.0
     # via inflect
-nodeenv==1.9.1
-    # via pre-commit
 num2words==0.5.14
     # via quantulum3
-oauthlib==3.3.1
-    # via requests-oauthlib
 openpyxl==3.1.5
     # via hdx-python-utilities
-packaging==25.0
-    # via
-    #   mkdocs
-    #   pytest
-paginate==0.5.7
-    # via mkdocs-material
-pathspec==0.12.1
-    # via mkdocs
 petl==1.7.17
     # via frictionless
-platformdirs==4.5.1
-    # via
-    #   mkdocs-get-deps
-    #   virtualenv
-pluggy==1.6.0
-    # via
-    #   pytest
-    #   pytest-cov
 ply==3.11
     # via
     #   jsonpath-ng
     #   libhxl
 pockets==0.9.1
     # via sphinxcontrib-napoleon
-pre-commit==4.5.1
-    # via hdx-python-api (pyproject.toml)
-pyasn1==0.6.1
-    # via
-    #   pyasn1-modules
-    #   rsa
-pyasn1-modules==0.4.2
-    # via google-auth
 pydantic==2.12.5
     # via frictionless
 pydantic-core==2.41.5
     # via pydantic
 pygments==2.19.2
-    # via
-    #   mkdocs-material
-    #   pytest
-    #   rich
-pymdown-extensions==10.19.1
-    # via mkdocs-material
+    # via rich
 pyphonetics==0.5.3
     # via hdx-python-utilities
-pytest==9.0.2
-    # via
-    #   hdx-python-api (pyproject.toml)
-    #   pytest-check
-    #   pytest-cov
-pytest-check==2.6.2
-    # via hdx-python-api (pyproject.toml)
-pytest-cov==7.0.0
-    # via hdx-python-api (pyproject.toml)
 python-dateutil==2.9.0.post0
     # via
     #   frictionless
-    #   ghp-import
     #   hdx-python-utilities
     #   libhxl
 python-io-wrapper==0.3.1
@@ -220,14 +116,7 @@ python-slugify==8.0.4
 pyyaml==6.0.3
     # via
     #   frictionless
-    #   mkdocs
-    #   mkdocs-get-deps
-    #   pre-commit
-    #   pymdown-extensions
-    #   pyyaml-env-tag
     #   tableschema-to-template
-pyyaml-env-tag==1.1
-    # via mkdocs
 quantulum3==0.9.2
     # via hdx-python-api (pyproject.toml)
 ratelimit==2.2.1
@@ -242,13 +131,9 @@ requests==2.32.5
     #   ckanapi
     #   frictionless
     #   libhxl
-    #   mkdocs-material
     #   requests-file
-    #   requests-oauthlib
 requests-file==3.0.1
     # via hdx-python-utilities
-requests-oauthlib==2.0.0
-    # via google-auth-oauthlib
 rfc3986==2.0.0
     # via frictionless
 rich==14.2.0
@@ -257,12 +142,8 @@ rpds-py==0.30.0
     # via
     #   jsonschema
     #   referencing
-rsa==4.9.1
-    # via google-auth
-ruamel-yaml==0.18.17
+ruamel-yaml==0.19.1
     # via hdx-python-utilities
-ruamel-yaml-clib==0.2.15
-    # via ruamel-yaml
 setuptools==80.9.0
     # via ckanapi
 shellingham==1.5.4
@@ -291,7 +172,7 @@ text-unidecode==1.3
     # via python-slugify
 typeguard==4.4.4
     # via inflect
-typer==0.20.0
+typer==0.21.1
     # via frictionless
 typing-extensions==4.15.0
     # via
@@ -307,16 +188,12 @@ unidecode==1.4.0
     # via
     #   libhxl
     #   pyphonetics
-urllib3==2.6.2
+urllib3==2.6.3
     # via
     #   libhxl
     #   requests
 validators==0.35.0
     # via frictionless
-virtualenv==20.35.4
-    # via pre-commit
-watchdog==6.0.0
-    # via mkdocs
 wheel==0.45.1
     # via libhxl
 xlrd==2.0.2

hdx_python_api-6.6.0/ruff.toml

@@ -0,0 +1,10 @@
+target-version = "py310"
+src = ["src"]
+exclude = ["_version.py"]
+
+[lint]
+# List of rules: https://docs.astral.sh/ruff/rules/
+extend-select = [
+  "I",   # isort
+  "UP"   # Upgrade Python
+]

{hdx_python_api-6.5.6 → hdx_python_api-6.6.0}/src/hdx/api/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '6.5.6'
-__version_tuple__ = version_tuple = (6, 5, 6)
+__version__ = version = '6.6.0'
+__version_tuple__ = version_tuple = (6, 6, 0)
 
 __commit_id__ = commit_id = None

{hdx_python_api-6.5.6 → hdx_python_api-6.6.0}/src/hdx/api/configuration.py

@@ -5,12 +5,10 @@ import os
 from base64 import b64decode
 from collections import UserDict
 from os.path import expanduser, isfile, join
-from typing import Any, Dict, Optional, Tuple
+from typing import Any, Optional
 
 import ckanapi
 import requests
-
-from hdx.api import __version__
 from hdx.utilities.dictandlist import merge_two_dictionaries
 from hdx.utilities.email import Email
 from hdx.utilities.loader import load_json, load_yaml
@@ -18,6 +16,8 @@ from hdx.utilities.path import script_dir_plus_file
 from hdx.utilities.session import get_session
 from hdx.utilities.useragent import UserAgent, UserAgentError
 
+from hdx.api import __version__
+
 logger = logging.getLogger(__name__)
 
 
@@ -229,7 +229,7 @@ class Configuration(UserDict):
         Set HDX read only flag
 
         Args:
-            read_only (bool): Value to set HDX read only flag. Defaults to True.
+            read_only: Value to set HDX read only flag. Defaults to True.
         Returns:
             None
 
@@ -241,19 +241,19 @@ class Configuration(UserDict):
         Set HDX api key
 
         Args:
-            apikey (str): Value to set api key.
+            apikey: Value to set api key.
         Returns:
             None
 
         """
         self.hdx_key = apikey
 
-    def get_api_key(self) -> Optional[str]:
+    def get_api_key(self) -> str | None:
         """
         Return HDX api key or None if read only
 
         Returns:
-            Optional[str]: HDX api key or None if read only
+            HDX api key or None if read only
 
         """
         if self.hdx_read_only:
@@ -265,7 +265,7 @@ class Configuration(UserDict):
         Return user agent
 
         Returns:
-            str: User agent
+            User agent
 
         """
         return self.user_agent
@@ -275,7 +275,7 @@ class Configuration(UserDict):
         Return HDX web site url
 
         Returns:
-            str: HDX web site url
+            HDX web site url
 
         """
         return self.data[self.hdx_site]["url"]
@@ -288,17 +288,17 @@ class Configuration(UserDict):
             name: Dataset name
 
         Returns:
-            str: HDX dataset url
+            HDX dataset url
 
         """
         return f"{self.get_hdx_site_url()}/dataset/{name}"
 
-    def _get_credentials(self) -> Optional[Tuple[str, str]]:
+    def _get_credentials(self) -> tuple[str, str] | None:
         """
         Return HDX site username and password
 
         Returns:
-            Optional[Tuple[str, str]]: HDX site username and password or None
+            HDX site username and password or None
 
         """
         site = self.data[self.hdx_site]
@@ -315,7 +315,7 @@ class Configuration(UserDict):
         Return the session object
 
         Returns:
-            requests.Session: The session object
+            The session object
 
         """
         if self._session is None:
@@ -329,7 +329,7 @@ class Configuration(UserDict):
         Return the remote CKAN object (see ckanapi library)
 
         Returns:
-            ckanapi.RemoteCKAN: The remote CKAN object
+            The remote CKAN object
 
         """
         if self._remoteckan is None:
@@ -338,7 +338,7 @@ class Configuration(UserDict):
             )
         return self._remoteckan
 
-    def call_remoteckan(self, *args: Any, **kwargs: Any) -> Dict:
+    def call_remoteckan(self, *args: Any, **kwargs: Any) -> dict:
         """
         Calls the remote CKAN
 
@@ -347,7 +347,7 @@ class Configuration(UserDict):
             **kwargs: Keyword arguments to pass to remote CKAN call_action method
 
         Returns:
-            Dict: The response from the remote CKAN call_action method
+            The response from the remote CKAN call_action method
 
         """
         requests_kwargs = kwargs.get("requests_kwargs", {})
@@ -363,24 +363,24 @@ class Configuration(UserDict):
     def create_session_user_agent(
         cls,
         session: requests.Session = None,
-        user_agent: Optional[str] = None,
-        user_agent_config_yaml: Optional[str] = None,
-        user_agent_lookup: Optional[str] = None,
+        user_agent: str | None = None,
+        user_agent_config_yaml: str | None = None,
+        user_agent_lookup: str | None = None,
         use_env: bool = False,
         **kwargs: Any,
-    ) -> Tuple[requests.Session, str]:
+    ) -> tuple[requests.Session, str]:
         """
         Create session and user agent from configuration
 
         Args:
-            session (requests.Session): requests Session object to use. Defaults to calling hdx.utilities.session.get_session()
-            user_agent (Optional[str]): User agent string. HDXPythonLibrary/X.X.X- is prefixed.
-            user_agent_config_yaml (Optional[str]): Path to YAML user agent configuration. Ignored if user_agent supplied. Defaults to ~/.useragent.yaml.
-            user_agent_lookup (Optional[str]): Lookup key for YAML. Ignored if user_agent supplied.
-            use_env (bool): Whether to read environment variables. Defaults to False.
+            session: requests Session object to use. Defaults to calling hdx.utilities.session.get_session()
+            user_agent: User agent string. HDXPythonLibrary/X.X.X- is prefixed.
+            user_agent_config_yaml: Path to YAML user agent configuration. Ignored if user_agent supplied. Defaults to ~/.useragent.yaml.
+            user_agent_lookup: Lookup key for YAML. Ignored if user_agent supplied.
+            use_env: Whether to read environment variables. Defaults to False.
 
         Returns:
-            Tuple[requests.Session, str]: Tuple of (session, user agent)
+            Tuple of (session, user agent)
 
         """
         if not session:
@@ -416,13 +416,13 @@ class Configuration(UserDict):
         return session, ua
 
     def setup_session_remoteckan(
-        self, remoteckan: Optional[ckanapi.RemoteCKAN] = None, **kwargs: Any
+        self, remoteckan: ckanapi.RemoteCKAN | None = None, **kwargs: Any
     ) -> None:
         """
         Set up remote CKAN from provided CKAN or by creating from configuration
 
         Args:
-            remoteckan (Optional[ckanapi.RemoteCKAN]): CKAN instance. Defaults to setting one up from configuration.
+            remoteckan: CKAN instance. Defaults to setting one up from configuration.
 
         Returns:
             None
@@ -445,7 +445,7 @@ class Configuration(UserDict):
         Return the Email object (see :any:`Email`)
 
         Returns:
-            Email: The email object
+            The email object
 
         """
         if self._emailer is None:
@@ -482,7 +482,7 @@ class Configuration(UserDict):
         Read the HDX configuration
 
         Returns:
-            Configuration: The HDX configuration
+            The HDX configuration
 
         """
         if cls._configuration is None:
@@ -499,7 +499,7 @@ class Configuration(UserDict):
         Construct the HDX configuration
 
         Args:
-            configuration (Optional[Configuration]): Configuration instance. Defaults to setting one up from passed arguments.
+            configuration: Configuration instance. Defaults to setting one up from passed arguments.
             **kwargs: See below
             user_agent (str): User agent string. HDXPythonLibrary/X.X.X- is prefixed. Must be supplied if remoteckan is not.
             user_agent_config_yaml (str): Path to YAML user agent configuration. Ignored if user_agent supplied. Defaults to ~/.useragent.yaml.
@@ -531,15 +531,15 @@ class Configuration(UserDict):
     def _create(
         cls,
         configuration: Optional["Configuration"] = None,
-        remoteckan: Optional[ckanapi.RemoteCKAN] = None,
+        remoteckan: ckanapi.RemoteCKAN | None = None,
         **kwargs: Any,
     ) -> str:
         """
         Create HDX configuration
 
         Args:
-            configuration (Optional[Configuration]): Configuration instance. Defaults to setting one up from passed arguments.
-            remoteckan (Optional[ckanapi.RemoteCKAN]): CKAN instance. Defaults to setting one up from configuration.
+            configuration: Configuration instance. Defaults to setting one up from passed arguments.
+            remoteckan: CKAN instance. Defaults to setting one up from configuration.
             **kwargs: See below
             user_agent (str): User agent string. HDXPythonLibrary/X.X.X- is prefixed. Must be supplied if remoteckan is not.
             user_agent_config_yaml (str): Path to YAML user agent configuration. Ignored if user_agent supplied. Defaults to ~/.useragent.yaml.
@@ -559,7 +559,7 @@ class Configuration(UserDict):
             hdx_base_config_yaml (str): Path to YAML HDX base configuration. Defaults to library's internal hdx_base_configuration.yaml.
 
         Returns:
-            str: HDX site url
+            HDX site url
 
         """
         cls.setup(configuration, **kwargs)
@@ -570,15 +570,15 @@ class Configuration(UserDict):
     def create(
         cls,
         configuration: Optional["Configuration"] = None,
-        remoteckan: Optional[ckanapi.RemoteCKAN] = None,
+        remoteckan: ckanapi.RemoteCKAN | None = None,
         **kwargs: Any,
     ) -> str:
         """
         Create HDX configuration. Can only be called once (will raise an error if called more than once).
 
         Args:
-            configuration (Optional[Configuration]): Configuration instance. Defaults to setting one up from passed arguments.
-            remoteckan (Optional[ckanapi.RemoteCKAN]): CKAN instance. Defaults to setting one up from configuration.
+            configuration: Configuration instance. Defaults to setting one up from passed arguments.
+            remoteckan: CKAN instance. Defaults to setting one up from configuration.
             **kwargs: See below
             user_agent (str): User agent string. HDXPythonLibrary/X.X.X- is prefixed. Must be supplied if remoteckan is not.
             user_agent_config_yaml (str): Path to YAML user agent configuration. Ignored if user_agent supplied. Defaults to ~/.useragent.yaml.
@@ -598,7 +598,7 @@ class Configuration(UserDict):
             hdx_base_config_yaml (str): Path to YAML HDX base configuration. Defaults to library's internal hdx_base_configuration.yaml.
 
         Returns:
-            str: HDX site url
+            HDX site url
 
         """
         if cls._configuration is not None: