hdx-python-country 3.8.8__tar.gz → 3.9.0__tar.gz

{hdx_python_country-3.8.8 → hdx_python_country-3.9.0}/.config/pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
       - id: end-of-file-fixer
       - id: check-ast
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.6
+    rev: v0.9.10
     hooks:
       # Run the linter.
       - id: ruff
@@ -17,7 +17,7 @@ repos:
       - id: ruff-format
         args: [--config, .config/ruff.toml]
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.5.15
+    rev: 0.6.5
     hooks:
       # Run the pip compile
       - id: pip-compile

{hdx_python_country-3.8.8 → hdx_python_country-3.9.0}/.config/ruff.toml

@@ -1,4 +1,3 @@
-line-length = 79
 exclude = ["_version.py"]
 
 [lint]

{hdx_python_country-3.8.8 → hdx_python_country-3.9.0}/.github/workflows/publish.yaml

@@ -8,6 +8,13 @@ jobs:
   publish:
     runs-on: ubuntu-latest
 
+    environment:
+      name: pypi
+      url: https://pypi.org/p/hdx-python-utilities
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
     steps:
     - uses: actions/checkout@v4
     - name: Get history and tags for versioning to work
@@ -26,9 +33,5 @@ jobs:
     - name: Build with hatch
       run: |
         hatch build
-    - name: Publish with hatch
-      env:
-        HATCH_INDEX_USER: ${{secrets.HATCH_INDEX_USER}}
-        HATCH_INDEX_AUTH: ${{secrets.HATCH_INDEX_AUTH}}
-      run: |
-        hatch publish
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

{hdx_python_country-3.8.8 → hdx_python_country-3.9.0}/.github/workflows/run-python-tests.yaml

@@ -17,6 +17,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
 
+    permissions:
+      checks: write
+      pull-requests: write
+
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python

{hdx_python_country-3.8.8 → hdx_python_country-3.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hdx-python-country
-Version: 3.8.8
+Version: 3.9.0
 Summary: HDX Python country code and exchange rate (fx) utilities
 Project-URL: Homepage, https://github.com/OCHA-DAP/hdx-python-country
 Author: Michael Rans
@@ -25,11 +25,13 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.8
-Requires-Dist: hdx-python-utilities>=3.8.0
+Requires-Dist: hdx-python-utilities>=3.8.5
 Requires-Dist: libhxl>=5.2.2
 Requires-Dist: tenacity
 Provides-Extra: dev
 Requires-Dist: pre-commit; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkapi; extra == 'docs'
 Provides-Extra: test
 Requires-Dist: pytest; extra == 'test'
 Requires-Dist: pytest-cov; extra == 'test'

hdx_python_country-3.9.0/documentation/.readthedocs.yaml

@@ -0,0 +1,14 @@
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+  jobs:
+    pre_build:
+      - pip install .[docs]
+
+mkdocs:
+  configuration: documentation/mkdocs.yaml

hdx_python_country-3.9.0/documentation/mkdocs.yaml

@@ -0,0 +1,17 @@
+site_name: HDX Python Country
+repo_url: https://github.com/OCHA-DAP/hdx-python-country/
+repo_name: OCHA-DAP/hdx-python-country
+docs_dir: .
+site_dir: ../site
+theme:
+  name: material
+  highlightjs: true
+plugins:
+  - search
+  - mkapi
+nav:
+  - Home: index.md
+  - API Documentation:
+    - Countries: $src/hdx.location.country.*
+    - Administration Level: $src/hdx.location.adminlevel.*
+    - Currencies: $src/hdx.location.currency.*

{hdx_python_country-3.8.8 → hdx_python_country-3.9.0}/pyproject.toml

@@ -34,7 +34,7 @@ classifiers = [
 requires-python = ">=3.8"
 
 dependencies = [
-    "hdx-python-utilities>=3.8.0",
+    "hdx-python-utilities>=3.8.5",
     "libhxl>=5.2.2",
     "tenacity",
 ]
@@ -50,7 +50,7 @@ Homepage = "https://github.com/OCHA-DAP/hdx-python-country"
 [project.optional-dependencies]
 test = ["pytest", "pytest-cov"]
 dev = ["pre-commit"]
-
+docs = ["mkapi"]
 
 #########
 # Hatch #
@@ -92,7 +92,7 @@ run = """
        """
 
 [tool.hatch.envs.hatch-static-analysis]
-dependencies = ["ruff==0.8.6"]
+dependencies = ["ruff==0.9.10"]
 
 [tool.hatch.envs.hatch-static-analysis.scripts]
 format-check = ["ruff format --config .config/ruff.toml --check --diff {args:.}",]

{hdx_python_country-3.8.8 → hdx_python_country-3.9.0}/requirements.txt

@@ -2,13 +2,19 @@
 #    uv pip compile pyproject.toml --resolver=backtracking --all-extras -o requirements.txt
 annotated-types==0.7.0
     # via pydantic
-attrs==24.3.0
+astdoc==1.1.5
+    # via mkapi
+attrs==25.3.0
     # via
     #   frictionless
     #   jsonlines
     #   jsonschema
     #   referencing
-certifi==2024.12.14
+babel==2.17.0
+    # via mkdocs-material
+backrefs==5.8
+    # via mkdocs-material
+certifi==2025.1.31
     # via requests
 cfgv==3.4.0
     # via pre-commit
@@ -17,33 +23,43 @@ chardet==5.2.0
 charset-normalizer==3.4.1
     # via requests
 click==8.1.8
-    # via typer
-coverage==7.6.10
+    # via
+    #   mkdocs
+    #   typer
+colorama==0.4.6
+    # via mkdocs-material
+coverage==7.7.0
     # via pytest-cov
 distlib==0.3.9
     # via virtualenv
 et-xmlfile==2.0.0
     # via openpyxl
-filelock==3.16.1
+filelock==3.18.0
     # via virtualenv
 frictionless==5.18.0
     # via hdx-python-utilities
-hdx-python-utilities==3.8.0
+ghp-import==2.1.0
+    # via mkdocs
+hdx-python-utilities==3.8.5
     # via hdx-python-country (pyproject.toml)
-humanize==4.11.0
+humanize==4.12.1
     # via frictionless
-identify==2.6.5
+identify==2.6.9
     # via pre-commit
 idna==3.10
     # via requests
 ijson==3.3.0
     # via hdx-python-utilities
-iniconfig==2.0.0
+iniconfig==2.1.0
     # via pytest
 isodate==0.7.2
     # via frictionless
-jinja2==3.1.5
-    # via frictionless
+jinja2==3.1.6
+    # via
+    #   frictionless
+    #   mkapi
+    #   mkdocs
+    #   mkdocs-material
 jsonlines==4.0.0
     # via hdx-python-utilities
 jsonpath-ng==1.7.0
@@ -58,41 +74,77 @@ libhxl==5.2.2
     # via hdx-python-country (pyproject.toml)
 loguru==0.7.3
     # via hdx-python-utilities
+markdown==3.7
+    # via
+    #   astdoc
+    #   mkdocs
+    #   mkdocs-material
+    #   pymdown-extensions
 markdown-it-py==3.0.0
     # via rich
 marko==2.1.2
     # via frictionless
 markupsafe==3.0.2
-    # via jinja2
+    # via
+    #   jinja2
+    #   mkdocs
 mdurl==0.1.2
     # via markdown-it-py
+mergedeep==1.3.4
+    # via
+    #   mkdocs
+    #   mkdocs-get-deps
+mkapi==4.1.3
+    # via hdx-python-country (pyproject.toml)
+mkdocs==1.6.1
+    # via
+    #   mkapi
+    #   mkdocs-material
+mkdocs-get-deps==0.2.0
+    # via mkdocs
+mkdocs-material==9.6.9
+    # via mkapi
+mkdocs-material-extensions==1.3.1
+    # via mkdocs-material
 nodeenv==1.9.1
     # via pre-commit
 openpyxl==3.1.5
     # via hdx-python-utilities
 packaging==24.2
-    # via pytest
+    # via
+    #   mkdocs
+    #   pytest
+paginate==0.5.7
+    # via mkdocs-material
+pathspec==0.12.1
+    # via mkdocs
 petl==1.7.15
     # via frictionless
-platformdirs==4.3.6
-    # via virtualenv
+platformdirs==4.3.7
+    # via
+    #   mkdocs-get-deps
+    #   virtualenv
 pluggy==1.5.0
     # via pytest
 ply==3.11
     # via
     #   jsonpath-ng
     #   libhxl
-pre-commit==4.0.1
+pre-commit==4.2.0
     # via hdx-python-country (pyproject.toml)
-pydantic==2.10.5
+pydantic==2.10.6
     # via frictionless
 pydantic-core==2.27.2
     # via pydantic
 pygments==2.19.1
-    # via rich
+    # via
+    #   mkdocs-material
+    #   rich
+pymdown-extensions==10.14.3
+    # via mkdocs-material
 pyphonetics==0.5.3
     # via hdx-python-utilities
-pytest==8.3.4
+pytest==8.3.5
     # via
     #   hdx-python-country (pyproject.toml)
     #   pytest-cov
@@ -101,6 +153,7 @@ pytest-cov==6.0.0
 python-dateutil==2.9.0.post0
     # via
     #   frictionless
+    #   ghp-import
     #   hdx-python-utilities
     #   libhxl
 python-io-wrapper==0.3.1
@@ -110,11 +163,17 @@ python-slugify==8.0.4
 pyyaml==6.0.2
     # via
     #   frictionless
+    #   mkdocs
+    #   mkdocs-get-deps
     #   pre-commit
+    #   pymdown-extensions
+    #   pyyaml-env-tag
     #   tableschema-to-template
+pyyaml-env-tag==0.1
+    # via mkdocs
 ratelimit==2.2.1
     # via hdx-python-utilities
-referencing==0.35.1
+referencing==0.36.2
     # via
     #   jsonschema
     #   jsonschema-specifications
@@ -122,14 +181,17 @@ requests==2.32.3
     # via
     #   frictionless
     #   libhxl
+    #   mkdocs-material
     #   requests-file
 requests-file==2.1.0
     # via hdx-python-utilities
 rfc3986==2.0.0
     # via frictionless
 rich==13.9.4
-    # via typer
-rpds-py==0.22.3
+    # via
+    #   mkapi
+    #   typer
+rpds-py==0.23.1
     # via
     #   jsonschema
     #   referencing
@@ -145,7 +207,7 @@ six==1.17.0
     # via python-dateutil
 stringcase==1.2.0
     # via frictionless
-structlog==24.4.0
+structlog==25.2.0
     # via libhxl
 tableschema-to-template==0.0.13
     # via hdx-python-utilities
@@ -155,13 +217,14 @@ tenacity==9.0.0
     # via hdx-python-country (pyproject.toml)
 text-unidecode==1.3
     # via python-slugify
-typer==0.15.1
+typer==0.15.2
     # via frictionless
 typing-extensions==4.12.2
     # via
     #   frictionless
     #   pydantic
     #   pydantic-core
+    #   referencing
     #   typer
 unidecode==1.3.8
     # via
@@ -173,8 +236,10 @@ urllib3==2.3.0
     #   requests
 validators==0.34.0
     # via frictionless
-virtualenv==20.28.1
+virtualenv==20.29.3
     # via pre-commit
+watchdog==6.0.0
+    # via mkdocs
 wheel==0.45.1
     # via libhxl
 xlrd==2.0.1
@@ -183,7 +248,7 @@ xlrd3==1.1.0
     # via libhxl
 xlsx2csv==0.8.4
     # via hdx-python-utilities
-xlsxwriter==3.2.0
+xlsxwriter==3.2.2
     # via tableschema-to-template
 xlwt==1.3.0
     # via hdx-python-utilities

{hdx_python_country-3.8.8 → hdx_python_country-3.9.0}/src/hdx/location/_version.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '3.8.8'
-__version_tuple__ = version_tuple = (3, 8, 8)
+__version__ = version = '3.9.0'
+__version_tuple__ = version_tuple = (3, 9, 0)

{hdx_python_country-3.8.8 → hdx_python_country-3.9.0}/src/hdx/location/adminlevel.py

@@ -67,9 +67,7 @@ class AdminLevel:
         self.retriever: Optional[Retrieve] = retriever
         self.countries_fuzzy_try = admin_config.get("countries_fuzzy_try")
         self.admin_name_mappings = admin_config.get("admin_name_mappings", {})
-        self.admin_name_replacements = admin_config.get(
-            "admin_name_replacements", {}
-        )
+        self.admin_name_replacements = admin_config.get("admin_name_replacements", {})
         self.admin_fuzzy_dont = admin_config.get("admin_fuzzy_dont", list())
         self.pcodes = []
         self.pcode_lengths = {}
@@ -135,9 +133,7 @@ class AdminLevel:
             try:
                 url_to_use = retriever.download_file(url)
             except DownloadError:
-                logger.exception(
-                    f"Setup of libhxl Dataset object with {url} failed!"
-                )
+                logger.exception(f"Setup of libhxl Dataset object with {url} failed!")
                 raise
         else:
             url_to_use = url
@@ -147,9 +143,7 @@ class AdminLevel:
                 InputOptions(InputOptions(allow_local=True, encoding="utf-8")),
             )
         except (FileNotFoundError, HXLIOException):
-            logger.exception(
-                f"Setup of libhxl Dataset object with {url} failed!"
-            )
+            logger.exception(f"Setup of libhxl Dataset object with {url} failed!")
             raise
 
     def setup_row(
@@ -178,9 +172,7 @@ class AdminLevel:
         self.pcode_to_name[pcode] = adm_name
         self.pcode_to_iso3[pcode] = countryiso3
         if not adm_name:
-            logger.error(
-                f"Admin name is blank for pcode {pcode} of {countryiso3}!"
-            )
+            logger.error(f"Admin name is blank for pcode {pcode} of {countryiso3}!")
             return
 
         adm_name = normalise(adm_name)
@@ -189,9 +181,7 @@ class AdminLevel:
         self.name_to_pcode[countryiso3] = name_to_pcode
 
         if self.use_parent:
-            name_parent_to_pcode = self.name_parent_to_pcode.get(
-                countryiso3, {}
-            )
+            name_parent_to_pcode = self.name_parent_to_pcode.get(countryiso3, {})
             name_to_pcode = name_parent_to_pcode.get(parent, {})
             name_to_pcode[adm_name] = pcode
             name_parent_to_pcode[parent] = name_to_pcode
@@ -216,9 +206,7 @@ class AdminLevel:
             None
         """
         if countryiso3s:
-            countryiso3s = [
-                countryiso3.upper() for countryiso3 in countryiso3s
-            ]
+            countryiso3s = [countryiso3.upper() for countryiso3 in countryiso3s]
         self.use_parent = "parent" in admin_info[0]
         for row in admin_info:
             countryiso3 = row["iso3"].upper()
@@ -244,13 +232,9 @@ class AdminLevel:
         Returns:
             None
         """
-        admin_info = libhxl_dataset.with_rows(
-            f"#geo+admin_level={self.admin_level}"
-        )
+        admin_info = libhxl_dataset.with_rows(f"#geo+admin_level={self.admin_level}")
         if countryiso3s:
-            countryiso3s = [
-                countryiso3.upper() for countryiso3 in countryiso3s
-            ]
+            countryiso3s = [countryiso3.upper() for countryiso3 in countryiso3s]
         self.use_parent = "#adm+code+parent" in admin_info.display_tags
         for row in admin_info:
             countryiso3 = row.get("#country+code").upper()
@@ -411,9 +395,7 @@ class AdminLevel:
         pcode_format = self.pcode_formats.get(countryiso3)
         if not pcode_format:
             if self.get_admin_level(countryiso3) == 1:
-                return self.convert_admin1_pcode_length(
-                    countryiso3, pcode, logname
-                )
+                return self.convert_admin1_pcode_length(countryiso3, pcode, logname)
             return None
         countryiso, digits = match.groups()
         countryiso_length = len(countryiso)
@@ -465,15 +447,10 @@ class AdminLevel:
                 if admin_length > 2 and pos in self.zeroes[countryiso3]:
                     pcode_part = f"0{pcode_part}"
                     if self.parent_admins and admin_no < self.admin_level:
-                        parent_pcode = [
-                            pcode_parts[i] for i in range(admin_no)
-                        ]
+                        parent_pcode = [pcode_parts[i] for i in range(admin_no)]
                         parent_pcode.append(pcode_part[:admin_length])
                         parent_pcode = "".join(parent_pcode)
-                        if (
-                            parent_pcode
-                            not in self.parent_admins[admin_no - 1]
-                        ):
+                        if parent_pcode not in self.parent_admins[admin_no - 1]:
                             pcode_part = pcode_part[1:]
                         else:
                             admin_changes.append(str(admin_no))
@@ -483,15 +460,10 @@ class AdminLevel:
                 if admin_length <= 2 and pcode_part[0] == "0":
                     pcode_part = pcode_part[1:]
                     if self.parent_admins and admin_no < self.admin_level:
-                        parent_pcode = [
-                            pcode_parts[i] for i in range(admin_no)
-                        ]
+                        parent_pcode = [pcode_parts[i] for i in range(admin_no)]
                         parent_pcode.append(pcode_part[:admin_length])
                         parent_pcode = "".join(parent_pcode)
-                        if (
-                            parent_pcode
-                            not in self.parent_admins[admin_no - 1]
-                        ):
+                        if parent_pcode not in self.parent_admins[admin_no - 1]:
                             pcode_part = f"0{pcode_part}"
                         else:
                             admin_changes.append(str(admin_no))
@@ -533,11 +505,7 @@ class AdminLevel:
         country_pcodelength = self.pcode_lengths.get(countryiso3)
         if not country_pcodelength:
             return None
-        if (
-            pcode_length == country_pcodelength
-            or pcode_length < 4
-            or pcode_length > 6
-        ):
+        if pcode_length == country_pcodelength or pcode_length < 4 or pcode_length > 6:
             return None
         if country_pcodelength == 4:
             pcode = f"{Country.get_iso2_from_iso3(pcode[:3])}{pcode[-2:]}"
@@ -690,9 +658,7 @@ class AdminLevel:
         pcode = name_to_pcode.get(
             normalised_name, name_to_pcode.get(alt_normalised_name)
         )
-        if not pcode and name.lower() in self.get_admin_fuzzy_dont(
-            countryiso3, parent
-        ):
+        if not pcode and name.lower() in self.get_admin_fuzzy_dont(countryiso3, parent):
             if logname:
                 self.ignored.add((logname, countryiso3, name))
             return None
@@ -836,16 +802,12 @@ class AdminLevel:
                 return name, True
             # name looks like a p-code, but doesn't match p-codes
             # so try adjusting p-code length
-            pcode = self.convert_admin_pcode_length(
-                countryiso3, pcode, **kwargs
-            )
+            pcode = self.convert_admin_pcode_length(countryiso3, pcode, **kwargs)
             return pcode, True
         else:
             normalised_name = normalise(name)
             if parent:
-                name_parent_to_pcode = self.name_parent_to_pcode.get(
-                    countryiso3
-                )
+                name_parent_to_pcode = self.name_parent_to_pcode.get(countryiso3)
                 if name_parent_to_pcode:
                     name_to_pcode = name_parent_to_pcode.get(parent)
                     if name_to_pcode is not None:
@@ -860,9 +822,7 @@ class AdminLevel:
                         return pcode, True
             if not fuzzy_match or len(normalised_name) < fuzzy_length:
                 return None, True
-            pcode = self.fuzzy_pcode(
-                countryiso3, name, normalised_name, **kwargs
-            )
+            pcode = self.fuzzy_pcode(countryiso3, name, normalised_name, **kwargs)
             return pcode, False
 
     def output_matches(self) -> List[str]:
@@ -905,7 +865,9 @@ class AdminLevel:
             if len(error) == 2:
                 line = f"{error[0]} - Could not find {error[1]} in map names!"
             else:
-                line = f"{error[0]} - {error[1]}: Could not find {error[2]} in map names!"
+                line = (
+                    f"{error[0]} - {error[1]}: Could not find {error[2]} in map names!"
+                )
             logger.error(line)
             output.append(line)
         return output