hdx-python-api 6.3.0__tar.gz → 6.3.2__tar.gz

{hdx_python_api-6.3.0 → hdx_python_api-6.3.2}/.config/pre-commit-config.yaml

@@ -1,15 +1,14 @@
 default_language_version:
-    python: python3.11
+    python: python3.12
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
-        exclude: test_scraper_.*\.json
       - id: check-ast
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.2
+    rev: v0.5.1
     hooks:
       # Run the linter.
       - id: ruff
@@ -18,7 +17,7 @@ repos:
       - id: ruff-format
         args: [--config, .config/ruff.toml]
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.1.38
+    rev: 0.2.13
     hooks:
       # Run the pip compile
       - id: pip-compile

{hdx_python_api-6.3.0 → hdx_python_api-6.3.2}/.github/workflows/run-python-tests.yaml

@@ -13,6 +13,10 @@ on:
     branches-ignore:
       - gh-pages
 
+concurrency:
+  group: ${{ github.head_ref || github.ref_name }}
+
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -26,17 +30,18 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install --upgrade hatch
+    - name: Install Hatch
+      uses: pypa/hatch@install
     - name: Test with hatch/pytest
       env:
         HDX_KEY_TEST: ${{ secrets.HDX_BOT_SCRAPERS_API_TOKEN }}
         GSHEET_AUTH: ${{ secrets.GSHEET_AUTH }}
       run: |
-        hatch run test:test
+        hatch test
     - name: Check styling
       if: always()
       run: |
-        hatch run lint:style
+        hatch fmt --check
     - name: Publish Unit Test Results
       uses: EnricoMi/publish-unit-test-result-action@v2
       if: always()

{hdx_python_api-6.3.0 → hdx_python_api-6.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: hdx-python-api
-Version: 6.3.0
+Version: 6.3.2
 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
@@ -28,8 +28,8 @@ Requires-Python: >=3.8
 Requires-Dist: ckanapi>=4.8
 Requires-Dist: defopt>=6.4.0
 Requires-Dist: email-validator
-Requires-Dist: hdx-python-country>=3.7.2
-Requires-Dist: hdx-python-utilities>=3.6.9
+Requires-Dist: hdx-python-country>=3.7.7
+Requires-Dist: hdx-python-utilities>=3.7.2
 Requires-Dist: libhxl>=5.2.1
 Requires-Dist: makefun
 Requires-Dist: ndg-httpsclient

{hdx_python_api-6.3.0 → hdx_python_api-6.3.2}/pyproject.toml

@@ -37,8 +37,8 @@ dependencies = [
     "ckanapi>=4.8",
     "defopt>=6.4.0",
     "email_validator",
-    "hdx-python-country>=3.7.2",
-    "hdx-python-utilities>=3.6.9",
+    "hdx-python-country>=3.7.7",
+    "hdx-python-utilities>=3.7.2",
     "libhxl>=5.2.1",
     "makefun",
     "ndg-httpsclient",
@@ -84,25 +84,21 @@ version_scheme = "python-simplified-semver"
 
 # Tests
 
-[tool.hatch.envs.test]
+[tool.hatch.envs.hatch-test]
 features = ["test"]
 
-[tool.hatch.envs.test.scripts]
-test = """
+[[tool.hatch.envs.hatch-test.matrix]]
+python = ["3.12"]
+
+[tool.hatch.envs.hatch-test.scripts]
+run = """
        pytest -c .config/pytest.ini --rootdir=. --junitxml=test-results.xml \
        --cov --cov-config=.config/coveragerc --no-cov-on-fail \
        --cov-report=lcov --cov-report=term-missing
        """
 
-[[tool.hatch.envs.test.matrix]]
-python = ["3.12"]
-
-[tool.hatch.envs.lint]
-detached = true
-dependencies = ["ruff"]
-
-[tool.hatch.envs.lint.scripts]
-style = [
-  "ruff check --config .config/ruff.toml --diff {args:.}",
-  "ruff format --config .config/ruff.toml --diff {args:.}",
-]
+[tool.hatch.envs.hatch-static-analysis.scripts]
+format-check = ["ruff format --config .config/ruff.toml --check --diff {args:.}",]
+format-fix = ["ruff format --config .config/ruff.toml {args:.}",]
+lint-check = ["ruff check --config .config/ruff.toml {args:.}",]
+lint-fix = ["ruff check --config .config/ruff.toml --fix {args:.}",]

{hdx_python_api-6.3.0 → hdx_python_api-6.3.2}/requirements.txt

@@ -8,9 +8,9 @@ attrs==23.2.0
     #   jsonlines
     #   jsonschema
     #   referencing
-cachetools==5.3.3
+cachetools==5.4.0
     # via google-auth
-certifi==2024.6.2
+certifi==2024.7.4
     # via requests
 cffi==1.16.0
     # via cryptography
@@ -21,13 +21,15 @@ chardet==5.2.0
 charset-normalizer==3.3.2
     # via requests
 ckanapi==4.8
+    # via hdx-python-api (pyproject.toml)
 click==8.1.7
     # via typer
-coverage==7.5.3
+coverage==7.6.0
     # via pytest-cov
-cryptography==42.0.8
+cryptography==43.0.0
     # via pyopenssl
 defopt==6.4.0
+    # via hdx-python-api (pyproject.toml)
 distlib==0.3.8
     # via virtualenv
 dnspython==2.6.1
@@ -38,34 +40,39 @@ docopt==0.6.2
     #   num2words
 docutils==0.21.2
     # via defopt
-email-validator==2.1.1
+email-validator==2.2.0
+    # via hdx-python-api (pyproject.toml)
 et-xmlfile==1.1.0
     # via openpyxl
-filelock==3.14.0
+filelock==3.15.4
     # via virtualenv
 frictionless==5.17.0
     # via hdx-python-utilities
-google-auth==2.29.0
+google-auth==2.32.0
     # via
     #   google-auth-oauthlib
     #   gspread
-google-auth-oauthlib==1.2.0
+google-auth-oauthlib==1.2.1
     # via gspread
 gspread==6.1.2
-hdx-python-country==3.7.2
-hdx-python-utilities==3.6.9
-    # via hdx-python-country
-humanize==4.9.0
+    # via hdx-python-api (pyproject.toml)
+hdx-python-country==3.7.7
+    # via hdx-python-api (pyproject.toml)
+hdx-python-utilities==3.7.2
+    # via
+    #   hdx-python-api (pyproject.toml)
+    #   hdx-python-country
+humanize==4.10.0
     # via frictionless
-identify==2.5.36
+identify==2.6.0
     # via pre-commit
 idna==3.7
     # via
     #   email-validator
     #   requests
-ijson==3.2.3
+ijson==3.3.0
     # via hdx-python-utilities
-inflect==7.2.1
+inflect==7.3.1
     # via quantulum3
 iniconfig==2.0.0
     # via pytest
@@ -77,37 +84,41 @@ jsonlines==4.0.0
     # via hdx-python-utilities
 jsonpath-ng==1.6.1
     # via libhxl
-jsonschema==4.22.0
+jsonschema==4.23.0
     # via
     #   frictionless
     #   tableschema-to-template
 jsonschema-specifications==2023.12.1
     # via jsonschema
 libhxl==5.2.1
-    # via hdx-python-country
+    # via
+    #   hdx-python-api (pyproject.toml)
+    #   hdx-python-country
 loguru==0.7.2
     # via hdx-python-utilities
-makefun==1.15.2
+makefun==1.15.4
+    # via hdx-python-api (pyproject.toml)
 markdown-it-py==3.0.0
     # via rich
-marko==2.0.3
+marko==2.1.2
     # via frictionless
 markupsafe==2.1.5
     # via jinja2
 mdurl==0.1.2
     # via markdown-it-py
-more-itertools==10.2.0
+more-itertools==10.3.0
     # via inflect
 ndg-httpsclient==0.5.1
+    # via hdx-python-api (pyproject.toml)
 nodeenv==1.9.1
     # via pre-commit
 num2words==0.5.13
     # via quantulum3
 oauthlib==3.2.2
     # via requests-oauthlib
-openpyxl==3.1.3
+openpyxl==3.1.5
     # via hdx-python-utilities
-packaging==24.0
+packaging==24.1
     # via pytest
 petl==1.7.15
     # via frictionless
@@ -122,8 +133,10 @@ ply==3.11
 pockets==0.9.1
     # via sphinxcontrib-napoleon
 pre-commit==3.7.1
+    # via hdx-python-api (pyproject.toml)
 pyasn1==0.6.0
     # via
+    #   hdx-python-api (pyproject.toml)
     #   ndg-httpsclient
     #   pyasn1-modules
     #   rsa
@@ -131,20 +144,25 @@ pyasn1-modules==0.4.0
     # via google-auth
 pycparser==2.22
     # via cffi
-pydantic==2.7.3
+pydantic==2.8.2
     # via frictionless
-pydantic-core==2.18.4
+pydantic-core==2.20.1
     # via pydantic
 pygments==2.18.0
     # via rich
-pyopenssl==24.1.0
-    # via ndg-httpsclient
+pyopenssl==24.2.1
+    # via
+    #   hdx-python-api (pyproject.toml)
+    #   ndg-httpsclient
 pyphonetics==0.5.3
     # via hdx-python-country
-pytest==8.2.2
-    # via pytest-cov
+pytest==8.3.2
+    # via
+    #   hdx-python-api (pyproject.toml)
+    #   pytest-cov
 pytest-cov==5.0.0
-python-dateutil==2.8.2
+    # via hdx-python-api (pyproject.toml)
+python-dateutil==2.9.0.post0
     # via
     #   frictionless
     #   hdx-python-utilities
@@ -160,7 +178,8 @@ pyyaml==6.0.1
     #   frictionless
     #   pre-commit
     #   tableschema-to-template
-quantulum3==0.9.1
+quantulum3==0.9.2
+    # via hdx-python-api (pyproject.toml)
 ratelimit==2.2.1
     # via hdx-python-utilities
 referencing==0.35.1
@@ -169,6 +188,7 @@ referencing==0.35.1
     #   jsonschema-specifications
 requests==2.32.3
     # via
+    #   hdx-python-api (pyproject.toml)
     #   ckanapi
     #   frictionless
     #   libhxl
@@ -182,7 +202,7 @@ rfc3986==2.0.0
     # via frictionless
 rich==13.7.1
     # via typer
-rpds-py==0.18.1
+rpds-py==0.19.1
     # via
     #   jsonschema
     #   referencing
@@ -192,7 +212,7 @@ ruamel-yaml==0.18.6
     # via hdx-python-utilities
 ruamel-yaml-clib==0.2.8
     # via ruamel-yaml
-setuptools==70.0.0
+setuptools==71.1.0
     # via ckanapi
 shellingham==1.5.4
     # via typer
@@ -211,7 +231,7 @@ sphinxcontrib-napoleon==0.7
     # via defopt
 stringcase==1.2.0
     # via frictionless
-structlog==24.2.0
+structlog==24.4.0
     # via libhxl
 tableschema-to-template==0.0.13
     # via hdx-python-utilities
@@ -223,10 +243,9 @@ typeguard==4.3.0
     # via inflect
 typer==0.12.3
     # via frictionless
-typing-extensions==4.12.1
+typing-extensions==4.12.2
     # via
     #   frictionless
-    #   inflect
     #   pydantic
     #   pydantic-core
     #   typeguard
@@ -235,13 +254,13 @@ unidecode==1.3.8
     # via
     #   libhxl
     #   pyphonetics
-urllib3==2.2.1
+urllib3==2.2.2
     # via
     #   libhxl
     #   requests
-validators==0.28.3
+validators==0.33.0
     # via frictionless
-virtualenv==20.26.2
+virtualenv==20.26.3
     # via pre-commit
 wheel==0.43.0
     # via libhxl

{hdx_python_api-6.3.0 → hdx_python_api-6.3.2}/src/hdx/api/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '6.3.0'
-__version_tuple__ = version_tuple = (6, 3, 0)
+__version__ = version = '6.3.2'
+__version_tuple__ = version_tuple = (6, 3, 2)

{hdx_python_api-6.3.0 → hdx_python_api-6.3.2}/src/hdx/data/dataset.py

@@ -986,6 +986,19 @@ class Dataset(HDXObject):
             match_resource_order,
             **kwargs,
         )
+        keep_crisis_tags = kwargs.get("keep_crisis_tags", True)
+        if keep_crisis_tags:
+            for tag in self.data["tags"]:
+                tag_name = tag["name"]
+                if tag_name[:7] != "crisis-":
+                    continue
+                found = False
+                for old_tag in self.old_data["tags"]:
+                    if old_tag["name"] == tag_name:
+                        found = True
+                        break
+                if not found:
+                    self.old_data["tags"].append(tag)
         self._prepare_hdx_call(self.old_data, kwargs)
         return self._revise_dataset(
             keys_to_delete,
@@ -1021,6 +1034,7 @@ class Dataset(HDXObject):
             create_default_views (bool): Whether to call package_create_default_resource_views. Defaults to True.
             hxl_update (bool): Whether to call package_hxl_update. Defaults to True.
             **kwargs: See below
+            keep_crisis_tags (bool): Whether to keep existing crisis tags. Defaults to True.
             updated_by_script (str): String to identify your script. Defaults to your user agent.
             batch (str): A string you can specify to show which datasets are part of a single batch update
 
@@ -1077,6 +1091,7 @@ class Dataset(HDXObject):
             create_default_views (bool): Whether to call package_create_default_resource_views (if updating). Defaults to True.
             hxl_update (bool): Whether to call package_hxl_update. Defaults to True.
             **kwargs: See below
+            keep_crisis_tags (bool): Whether to keep existing crisis tags. Defaults to True.
             updated_by_script (str): String to identify your script. Defaults to your user agent.
             batch (str): A string you can specify to show which datasets are part of a single batch update
 

{hdx_python_api-6.3.0 → hdx_python_api-6.3.2}/src/hdx/data/user.py

@@ -289,16 +289,21 @@ class User(HDXObject):
             organizations.append(org)
         return organizations
 
-    def check_organization_access(self, organization: str) -> bool:
+    def check_organization_access(
+        self, organization: str, permission: str = "read"
+    ) -> bool:
         """Check user is a member of a given organization.
 
         Args:
             organization (str): Organization id or name.
+            permission (str): Permission to check for. Defaults to 'read'.
 
         Returns:
             bool: True if the logged in user is a member of the organization.
         """
-        for organization_dict in self.get_organization_dicts():
+        for organization_dict in self.get_organization_dicts(
+            permission=permission
+        ):
             if organization_dict["id"] == organization:
                 return True
             if organization_dict["name"] == organization:
@@ -323,7 +328,7 @@ class User(HDXObject):
         user = User(configuration=configuration)
         try:
             return user.configuration.call_remoteckan(
-                cls.actions()["listorgs"]
+                cls.actions()["listorgs"], {"permission": permission}
             )
         except Exception:
             return []
@@ -355,16 +360,21 @@ class User(HDXObject):
         return organizations
 
     @classmethod
-    def check_current_user_organization_access(cls, organization: str) -> bool:
+    def check_current_user_organization_access(
+        cls, organization: str, permission: str = "read"
+    ) -> bool:
         """Check logged in user is a member of a given organization.
 
         Args:
             organization (str): Organization id or name.
+            permission (str): Permission to check for. Defaults to 'read'.
 
         Returns:
             bool: True if the logged in user is a member of the organization.
         """
-        for organization_dict in cls.get_current_user_organization_dicts():
+        for organization_dict in cls.get_current_user_organization_dicts(
+            permission=permission
+        ):
             if organization_dict["id"] == organization:
                 return True
             if organization_dict["name"] == organization:

hdx_python_api-6.3.2/tests/fixtures/Accepted_Tags.csv

@@ -0,0 +1,140 @@
+administrative boundaries-divisions
+affected area
+affected population
+africa
+agriculture-livestock
+aid effectiveness
+aid worker security
+aid workers
+americas
+asylum seekers
+aviation
+baseline population
+births
+border crossings
+boys
+camp coordination and camp management-cccm
+cash based interventions-cbi
+cash voucher assistance-cva
+casualties
+census
+central africa
+children
+climate hazards
+climate-weather
+cluster system
+community engagement
+complex emergency-conflict-security
+conflict-violence
+covid-19
+cyclones-hurricanes-typhoons
+damage assessment
+demographics
+development
+disability
+disaster risk reduction-drr
+disease
+displacement
+drought
+earthquake-tsunami
+eastern africa
+economics
+education
+education facilities-schools
+el nino-el nina
+elderly
+employment
+energy
+environment
+epidemics-outbreaks
+facilities-infrastructure
+fatalities
+female
+flooding-storm surge
+food security
+forced displacement
+forecasting
+funding
+gazetteer
+gender
+gender-based violence-gbv
+geodata
+girls
+global acute malnutrition-gam
+governance and civil society
+gross domestic product-gdp
+hazards and risk
+health
+health facilities
+horn of africa
+human rights
+humanitarian access
+humanitarian needs overview-hno
+humanitarian response plan-hrp
+hxl
+hydrology
+indicators
+integrated food security phase classification-ipc
+internally displaced persons-idp
+international aid transparency initiative-iati
+languages
+libya-floods
+literacy
+livelihoods
+logistics
+malaria
+malnutrition
+markets
+maternity
+men
+mental health
+migration
+morocco-earthquake
+mortality
+natural disasters
+needs assessment
+non-food items-nfi
+nutrition
+openstreetmap
+operational capacity
+operational partners
+operational presence
+opt-israel-hostilities
+peacekeeping
+people in need-pin
+points of interest-poi
+populated places-settlements
+population
+ports
+poverty
+protection
+railways
+refugee crisis
+refugees
+returnees
+rivers
+roads
+rural
+sahel
+services
+severe acute malnutrition-sam
+severity
+sex and age disaggregated data-sadd
+shelter
+social media data
+socioeconomics
+stateless persons
+survey
+sustainable development
+sustainable development goals-sdg
+topography
+trade
+transportation
+urban
+urban search and rescue-usar
+vaccination-immunization
+water sanitation and hygiene-wash
+west africa
+who is doing what and where-3w-4w-5w
+women
+youth