hdx-python-api 6.7.3__py3-none-any.whl → 6.7.5__py3-none-any.whl

hdx/api/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '6.7.3'
-__version_tuple__ = version_tuple = (6, 7, 3)
+__version__ = version = '6.7.5'
+__version_tuple__ = version_tuple = (6, 7, 5)
 
 __commit_id__ = commit_id = None

hdx/api/utilities/hdx_stats.py

@@ -4,12 +4,15 @@ from hdx.api.configuration import Configuration
 from hdx.data.hdxobject import HDXError
 
 
-def _call_stats_action(action: str, configuration: Configuration | None) -> dict:
+def _call_stats_action(
+    action: str, configuration: Configuration | None, data: dict | None = None
+) -> dict:
     """Call an HDX statistics action
 
     Args:
         action: CKAN action name
         configuration: HDX configuration. Defaults to global configuration.
+        data: Parameters to pass to the action. Defaults to None.
 
     Returns:
         Statistics dictionary
@@ -17,7 +20,7 @@ def _call_stats_action(action: str, configuration: Configuration | None) -> dict
     if configuration is None:
         configuration = Configuration.read()
     try:
-        return configuration.call_remoteckan(action, {})
+        return configuration.call_remoteckan(action, data or {})
     except Exception as e:
         raise HDXError(f"Failed when trying to call {action}!") from e
 
@@ -45,3 +48,39 @@ def push_general_stats(configuration: Configuration | None = None) -> dict:
         Statistics that were pushed
     """
     return _call_stats_action("hdx_push_general_stats", configuration)
+
+
+def get_user_statistics(
+    start_date: str | None = None,
+    end_date: str | None = None,
+    configuration: Configuration | None = None,
+) -> dict:
+    """Get the number of activities of each active user on HDX, optionally
+    between start and end dates. Requires sysadmin.
+
+    Args:
+        start_date: Count activities on or after this date eg. 2026-01-01. Defaults to None.
+        end_date: Count activities on or before this date. Defaults to None.
+        configuration: HDX configuration. Defaults to global configuration.
+
+    Returns:
+        Dictionary from user id to dictionary with keys id, name and no_of_activities
+    """
+    data = {}
+    if start_date:
+        data["start_date"] = start_date
+    if end_date:
+        data["end_date"] = end_date
+    return _call_stats_action("hdx_user_statistics", configuration, data)
+
+
+def get_organization_statistics(configuration: Configuration | None = None) -> dict:
+    """Get active and inactive organizations on HDX. Requires sysadmin.
+
+    Args:
+        configuration: HDX configuration. Defaults to global configuration.
+
+    Returns:
+        Dictionary with keys active_organizations and inactive_organizations
+    """
+    return _call_stats_action("hdx_organization_statistics", configuration)

hdx/data/dataset.py

@@ -148,6 +148,13 @@ class Dataset(HDXObject):
             "autocomplete": "package_autocomplete",
             "create_default_views": "package_create_default_resource_views",
             "fs_check_info": "fs_check_info_show",
+            "fs_check_reset": "hdx_fs_check_package_reset",
+            "shape_info": "shape_info_show",
+            "recommend_tags": "hdx_recommend_tags",
+            "allowed_for_datastore": "hdx_is_package_allowed_for_datastore",
+            "push_to_datastore": "hdx_push_resource_to_datastore",
+            "qa_completed": "hdx_mark_qa_completed",
+            "qa_revise_resources": "hdx_qa_package_revise_resource",
         }
 
     def __setitem__(self, key: Any, value: Any) -> None:
@@ -2347,6 +2354,136 @@ class Dataset(HDXObject):
             return result
         return []
 
+    def _set_from_package(self, package: dict) -> None:
+        """Set the dataset's metadata and resources from a package metadata
+        dictionary returned by HDX
+
+        Args:
+            package: Package metadata dictionary
+
+        Returns:
+            None
+        """
+        self.data = package
+        self.init_resources()
+        self.separate_resources()
+
+    def reset_fs_check(self, key: str = "fs_check_info") -> None:
+        """Clear a file structure check field of all the dataset's resources
+        in HDX. Requires sysadmin or permission to manage QA.
+
+        Args:
+            key: Resource field to clear. Defaults to fs_check_info.
+
+        Returns:
+            None
+        """
+        result = self._write_to_hdx(
+            "fs_check_reset", {"package_id": self.data["id"], "key": key}, "package_id"
+        )
+        self._set_from_package(result["package"])
+
+    def set_qa_completed(self, qa_completed: bool) -> None:
+        """Mark QA of the dataset in HDX as completed or not. Requires
+        sysadmin or permission to manage QA.
+
+        Args:
+            qa_completed: Whether QA is completed
+
+        Returns:
+            None
+        """
+        result = self._write_to_hdx(
+            "qa_completed", {"id": self.data["id"], "qa_completed": qa_completed}, "id"
+        )
+        self._set_from_package(result["package"])
+
+    def qa_revise_resources(self, key: str, value: Any) -> None:
+        """Set a QA field of all the dataset's resources in HDX. Requires
+        sysadmin or permission to manage QA.
+
+        Args:
+            key: Resource field eg. pii
+            value: Value to set
+
+        Returns:
+            None
+        """
+        result = self._write_to_hdx(
+            "qa_revise_resources",
+            {"id": self.data["id"], "key": key, "value": value},
+            "id",
+        )
+        self._set_from_package(result["package"])
+
+    def get_shape_info(self) -> list[dict]:
+        """Get geopreview shape information for the dataset's resources from
+        HDX
+
+        Returns:
+            List of dictionaries from resource name to shape information
+        """
+        success, result = self._read_from_hdx(
+            "dataset",
+            self.get_name_or_id(prefer_name=False),
+            "id",
+            self.actions()["shape_info"],
+        )
+        if success:
+            return result
+        return []
+
+    def get_recommended_tags(self) -> list[str]:
+        """Get tags recommended by HDX for the dataset based on its title and
+        organization. Tags are ordered from most to least recommended.
+
+        Returns:
+            List of recommended tags
+        """
+        data = {"title": self.data.get("title")}
+        organization = self.data.get("owner_org")
+        if organization:
+            data["organization"] = organization
+        try:
+            result = self.configuration.call_remoteckan(
+                self.actions()["recommend_tags"], data
+            )
+        except Exception as e:
+            raise HDXError("Failed when trying to get recommended tags!") from e
+        return [tag["name"] for tag in result]
+
+    def is_allowed_for_datastore(self) -> bool:
+        """Return if the dataset or its organization is in HDX's allowlist for
+        automatic loading of resources into the datastore
+
+        Returns:
+            Whether dataset is allowed for datastore
+        """
+        success, result = self._read_from_hdx(
+            "dataset",
+            self.data["id"],
+            "package_id",
+            self.actions()["allowed_for_datastore"],
+        )
+        if success:
+            return result
+        logger.debug(result)
+        return False
+
+    def push_to_datastore(self) -> bool:
+        """Submit all the dataset's CSV resources to DataPusher+ using HDX's
+        wrapper action. Requires sysadmin.
+
+        Returns:
+            True if submitted, False if not (eg. no CSV resources)
+        """
+        result = self._write_to_hdx(
+            "push_to_datastore", {"dataset_id": self.data["id"]}, "dataset_id"
+        )
+        if not result["success"]:
+            logger.debug(result["message"])
+        return result["success"]
+
     def generate_resource(
         self,
         folder: Path | str,

hdx/data/location.py

@@ -43,6 +43,8 @@ class Location(HDXObject):
             "delete": "group_delete",
             "list": "group_list",
             "autocomplete": "group_autocomplete",
+            "data_grid": "hdx_datagrid_show",
+            "invalidate_data_grid": "invalidate_data_completeness_for_location",
         }
 
     @classmethod
@@ -218,6 +220,47 @@ class Location(HDXObject):
             if len(group["name"]) == 3 and group.get("data_completeness") == "active"
         )
 
+    @staticmethod
+    def get_data_grid(
+        iso3: str, configuration: Configuration | None = None
+    ) -> dict | None:
+        """Get the Data Grid of a country. The dictionary has keys including
+        title, date, stats and categories. Each category has subcategories,
+        each with a list of datasets. Complementary datasets have
+        is_complementary set to True. Requires sysadmin.
+
+        Args:
+            iso3: Country ISO 3-letter code
+            configuration: HDX configuration. Defaults to global configuration.
+
+        Returns:
+            Data Grid dictionary or None if not found
+        """
+        location = Location(configuration=configuration)
+        success, result = location._read_from_hdx(
+            "location", iso3.lower(), "id", location.actions()["data_grid"]
+        )
+        if success:
+            return result
+        logger.debug(result)
+        return None
+
+    @staticmethod
+    def invalidate_data_grid(
+        iso3: str, configuration: Configuration | None = None
+    ) -> None:
+        """Clear HDX's cached Data Grid of a country. Requires sysadmin.
+
+        Args:
+            iso3: Country ISO 3-letter code
+            configuration: HDX configuration. Defaults to global configuration.
+
+        Returns:
+            None
+        """
+        location = Location(configuration=configuration)
+        location._write_to_hdx("invalidate_data_grid", {"name": iso3.lower()}, "name")
+
     def get_activities(self, all_pages: bool = False, **kwargs: Any) -> list[Activity]:
         """Get the activity stream of this location. One page of results (whose size
         is given by limit) is returned unless all_pages is True.

hdx/data/resource.py

@@ -74,6 +74,13 @@ class Resource(HDXObject):
             "datastore_search_sql": "datastore_search_sql",
             "datapusher_submit": "datapusher_submit",
             "datapusher_status": "datapusher_status",
+            "push_to_datastore": "hdx_push_resource_to_datastore",
+            "p_coded": "hdx_p_coded_resource_update",
+            "in_hapi": "hdx_mark_resource_in_hapi",
+            "in_quarantine": "hdx_mark_resource_in_quarantine",
+            "qa_patch": "hdx_qa_resource_patch",
+            "fs_check_revise": "hdx_fs_check_resource_revise",
+            "fs_check_reset": "hdx_fs_check_resource_reset",
         }
 
     def update_from_yaml(
@@ -1113,6 +1120,20 @@ class Resource(HDXObject):
             "resource_id",
         )
 
+    def push_to_datastore(self) -> bool:
+        """Submit the resource to DataPusher+ using HDX's wrapper action.
+        Unlike submit_to_datapusher, this requires sysadmin.
+
+        Returns:
+            True if submitted, False if not
+        """
+        result = self._write_to_hdx(
+            "push_to_datastore", {"resource_id": self.data["id"]}, "resource_id"
+        )
+        if not result["success"]:
+            logger.debug(result["message"])
+        return result["success"]
+
     def get_datapusher_status(self) -> dict | None:
         """Get the status of the resource's latest DataPusher+ job
 
@@ -1304,6 +1325,159 @@ class Resource(HDXObject):
             return json.loads(fs_check_info)
         return fs_check_info
 
+    def _set_from_package(self, package: dict) -> None:
+        """Set the resource's metadata from the matching resource in a package
+        metadata dictionary returned by HDX
+
+        Args:
+            package: Package metadata dictionary
+
+        Returns:
+            None
+        """
+        for resource in package.get("resources", []):
+            if resource["id"] == self.data["id"]:
+                self.data = resource
+                return
+
+    def revise_fs_check(self, key: str, value: Any) -> None:
+        """Set a file structure check field of the resource in HDX. If key is
+        fs_check_info and value is a dictionary, it is appended to the
+        existing check events (the last 20 are kept) rather than replacing
+        them. Requires sysadmin or permission to manage QA.
+
+        Args:
+            key: Resource field eg. fs_check_info
+            value: Value to set
+
+        Returns:
+            None
+        """
+        result = self._write_to_hdx(
+            "fs_check_revise",
+            {
+                "package_id": self.data["package_id"],
+                "id": self.data["id"],
+                "key": key,
+                "value": value,
+            },
+            "id",
+        )
+        self._set_from_package(result["package"])
+
+    def reset_fs_check(self, key: str = "fs_check_info") -> None:
+        """Clear a file structure check field of the resource in HDX. Requires
+        sysadmin or permission to manage QA.
+
+        Args:
+            key: Resource field to clear. Defaults to fs_check_info.
+
+        Returns:
+            None
+        """
+        result = self._write_to_hdx(
+            "fs_check_reset",
+            {"package_id": self.data["package_id"], "id": self.data["id"], "key": key},
+            "id",
+        )
+        self._set_from_package(result["package"])
+
+    def is_p_coded(self) -> bool | None:
+        """Return if the resource is marked as containing p-codes
+
+        Returns:
+            Whether resource is p-coded or None if not set
+        """
+        p_coded = self.data.get("p_coded")
+        if p_coded is None:
+            return None
+        if isinstance(p_coded, str):
+            return p_coded.lower() == "true"
+        return p_coded
+
+    def set_p_coded(self, p_coded: bool) -> None:
+        """Mark the resource in HDX as containing p-codes or not. Requires
+        sysadmin or permission to manage p-codes.
+
+        Args:
+            p_coded: Whether resource is p-coded
+
+        Returns:
+            None
+        """
+        self.data = self._write_to_hdx(
+            "p_coded", {"id": self.data["id"], "p_coded": p_coded}, "id"
+        )
+
+    def is_in_hapi(self) -> bool:
+        """Return if the resource is marked as being in HAPI
+
+        Returns:
+            Whether resource is in HAPI
+        """
+        return self.data.get("in_hapi") == "yes"
+
+    def set_in_hapi(self, in_hapi: bool) -> None:
+        """Mark the resource in HDX as being in HAPI or not. Requires sysadmin
+        or permission to manage the in HAPI flag.
+
+        Args:
+            in_hapi: Whether resource is in HAPI
+
+        Returns:
+            None
+        """
+        self.data = self._write_to_hdx(
+            "in_hapi",
+            {"id": self.data["id"], "in_hapi": "yes" if in_hapi else "no-data"},
+            "id",
+        )
+
+    def is_in_quarantine(self) -> bool:
+        """Return if the resource is in quarantine
+
+        Returns:
+            Whether resource is in quarantine
+        """
+        in_quarantine = self.data.get("in_quarantine", False)
+        if isinstance(in_quarantine, str):
+            return in_quarantine.lower() == "true"
+        return in_quarantine
+
+    def set_in_quarantine(self, in_quarantine: bool) -> None:
+        """Put the resource in HDX in quarantine or take it out. Quarantining
+        also removes the resource's shape_info and geopreview. Requires
+        sysadmin or permission to manage QA.
+
+        Args:
+            in_quarantine: Whether resource is in quarantine
+
+        Returns:
+            None
+        """
+        self.data = self._write_to_hdx(
+            "in_quarantine",
+            {
+                "id": self.data["id"],
+                "in_quarantine": "true" if in_quarantine else "false",
+            },
+            "id",
+        )
+
+    def qa_patch(self, **kwargs: Any) -> None:
+        """Patch QA fields of the resource in HDX eg. pii, sdc_report_flag,
+        broken_link. Requires sysadmin or permission to manage QA.
+
+        Args:
+            **kwargs: Resource fields to patch
+
+        Returns:
+            None
+        """
+        self.data = self._write_to_hdx(
+            "qa_patch", {"id": self.data["id"], **kwargs}, "id"
+        )
+
     def is_marked_data_updated(self) -> bool:
         """Return if the resource's data is marked to be updated
 

{hdx_python_api-6.7.3.dist-info → hdx_python_api-6.7.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: hdx-python-api
-Version: 6.7.3
+Version: 6.7.5
 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.10
 Requires-Dist: ckanapi>=4.11
 Requires-Dist: defopt>=7.0.0
 Requires-Dist: email-validator
-Requires-Dist: hdx-python-country>=4.2.3
-Requires-Dist: hdx-python-utilities>=4.2.1
+Requires-Dist: hdx-python-country>=4.2.4
+Requires-Dist: hdx-python-utilities>=4.2.3
 Requires-Dist: makefun
 Requires-Dist: requests
 Provides-Extra: docs

{hdx_python_api-6.7.3.dist-info → hdx_python_api-6.7.5.dist-info}/RECORD

@@ -1,5 +1,5 @@
 hdx/api/__init__.py,sha256=11ozJKiUsqDCZ3_mcAHhGYUyGK_Unl54djVSBBExFB4,59
-hdx/api/_version.py,sha256=O7pvZmvSWCf7hJuRAdEJClOMPVWnCFeffbn1fVR7KII,520
+hdx/api/_version.py,sha256=COiFxfgYaSnJUzlrh0vxGDx6Wn8d0Gbr-1uNuoVlOao,520
 hdx/api/configuration.py,sha256=9WvuVI-3th2Dv70_t_4VoyrlJwB_9qUSN5_zUKbp4sQ,23805
 hdx/api/hdx_base_configuration.yaml,sha256=jj2t5b7NnI499rHVwOjj3Q5BAjE8i7NDGVKnWZ5P5-4,2222
 hdx/api/locations.py,sha256=bFl_cKz_AEQzkE_xWOkrRlUQ0GT2LMPSk-G_LsbV-Ns,4099
@@ -9,15 +9,15 @@ hdx/api/utilities/date_helper.py,sha256=sXxjRtXz-2rpBVZBbJAk80gfjpYKl_AtHplWr-rn
 hdx/api/utilities/filestore_helper.py,sha256=0FcUpGHpYlAzlNDpDxdXbSqV6VHFfGCLakCmK37hieU,6917
 hdx/api/utilities/hdx_error_handler.py,sha256=x1rb2qBO0C6CJjqToSFj_XB1F3pf3nHpA8otxXfTFzA,8711
 hdx/api/utilities/hdx_state.py,sha256=KzrK0A-H5R6cRPqwF4d23_S_zfIa1ow4K5u46FesGmY,2442
-hdx/api/utilities/hdx_stats.py,sha256=Vc3CesIbROeumOmSyVItmUaGjFv0MF4r4mlKbpI0rxo,1474
+hdx/api/utilities/hdx_stats.py,sha256=JlEcF9LN-OjcVeh6C0te-nAlcO7W-JIpD5JJWTiWxs0,2847
 hdx/api/utilities/url_utils.py,sha256=Pb4r-BAqIHYmeoB_i7QjutDp6nOAUh_OHvCtiNLda3Y,4534
 hdx/data/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hdx/data/activity.py,sha256=YNa7hAgsMP96EIUX7UMInxAXnJ8TynE1KpecRrv8Vso,9200
-hdx/data/dataset.py,sha256=BdNPybJklyhI_IeyY0QGrohau6yTEv-jeFVFLjs5CeQ,101301
+hdx/data/dataset.py,sha256=-GQO08PK8u19O0qRWttg3AuPskPCwjffcE2mPq-7dQE,105903
 hdx/data/hdxobject.py,sha256=EG5KkVpi-yF6m6HVF79EqDneq1W7mo5M-bPJHG79T0I,28383
-hdx/data/location.py,sha256=CvDGfzQnPIB0aT7WOc60zhnAfvDFMJFcrbfacOsYR-U,9598
+hdx/data/location.py,sha256=UJPGKc8euAYFJsUFkdQtViLUwqNWYOWwaLELApAMHk4,11168
 hdx/data/organization.py,sha256=IRen2F2NsXLC8r-PVTS9eQp7LTn_44OcDUa1S7SCKiQ,13140
-hdx/data/resource.py,sha256=KuO9UB6OP7G2rcKcwTCjdfseQpcub-aK6LscXtI8IM8,50909
+hdx/data/resource.py,sha256=QDQJp7XoCDn9DmyWPgA2YCn8Z4HGwezEkFyae_YlFKI,56507
 hdx/data/resource_matcher.py,sha256=Yzk9pWa4zk1p09m6zcZMj0XZf5Y16Pa3KToOdUt7rP8,4247
 hdx/data/resource_view.py,sha256=GcYkh0iDAe6_m2ErY_A6i3Z7ZFX949eGt1TLnLZv_8s,7346
 hdx/data/showcase.py,sha256=vnRZ45xd9Ct65eFQkWZtMIJPFifZfKOrH4obO5D5Pvc,14062
@@ -27,7 +27,7 @@ hdx/facades/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hdx/facades/infer_arguments.py,sha256=DvyDuozfOPmoaV7HjhQySojGIrMWW9nos31auQBVVl8,4032
 hdx/facades/keyword_arguments.py,sha256=aVapHCfqBO6H7xxBgTdK9ISdgrBFsNypPDWihfQ3edU,1125
 hdx/facades/simple.py,sha256=QWsBkaHG_UM6X3Zu2u3LWVOQzeR24q-EUClrfsL_mkM,1064
-hdx_python_api-6.7.3.dist-info/METADATA,sha256=UI9iCTmytO8zgeetqK5dfGaRHW3d4qzu0ex1r8WE8c0,4946
-hdx_python_api-6.7.3.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-hdx_python_api-6.7.3.dist-info/licenses/LICENSE,sha256=wc-4GpMn-ODs-U_bTe1YCiPVgvcjzrpYOx2wPuyAeII,1079
-hdx_python_api-6.7.3.dist-info/RECORD,,
+hdx_python_api-6.7.5.dist-info/METADATA,sha256=C2mT_Q4SPSXjrlmzR_lHKSCdrO4YwxJPaMFHgsVcHHc,4946
+hdx_python_api-6.7.5.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+hdx_python_api-6.7.5.dist-info/licenses/LICENSE,sha256=wc-4GpMn-ODs-U_bTe1YCiPVgvcjzrpYOx2wPuyAeII,1079
+hdx_python_api-6.7.5.dist-info/RECORD,,