hdx-python-api 6.6.4__tar.gz → 6.6.6__tar.gz

{hdx_python_api-6.6.4 → hdx_python_api-6.6.6}/.pre-commit-config.yaml

@@ -12,7 +12,7 @@ repos:
       - id: check-ast
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.13
+    rev: v0.14.14
     hooks:
       # Run the linter.
       - id: ruff-check

{hdx_python_api-6.6.4 → hdx_python_api-6.6.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hdx-python-api
-Version: 6.6.4
+Version: 6.6.6
 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,10 +28,9 @@ Requires-Python: >=3.10
 Requires-Dist: ckanapi>=4.8
 Requires-Dist: defopt>=7.0.0
 Requires-Dist: email-validator
-Requires-Dist: hdx-python-country>=4.0.1
-Requires-Dist: hdx-python-utilities>=4.0.4
+Requires-Dist: hdx-python-country>=4.1.1
+Requires-Dist: hdx-python-utilities>=4.0.8
 Requires-Dist: makefun
-Requires-Dist: quantulum3
 Requires-Dist: requests
 Provides-Extra: docs
 Requires-Dist: mkapi; extra == 'docs'
@@ -53,3 +52,87 @@ For more information, please read the
 This library is part of the [Humanitarian Data Exchange](https://data.humdata.org/)
 (HDX) project. If you have humanitarian related data, please upload your datasets to
 HDX.
+
+# Development
+
+## Environment
+
+Development is currently done using Python 3.13. The environment can be created with:
+
+```shell
+    uv sync
+```
+
+This creates a .venv folder with the versions specified in the project's uv.lock file.
+
+### Pre-commit
+
+pre-commit will be installed when syncing uv. It is run every time you make a git
+commit if you call it like this:
+
+```shell
+    pre-commit install
+```
+
+With pre-commit, all code is formatted according to
+[ruff](https://docs.astral.sh/ruff/) guidelines.
+
+To check if your changes pass pre-commit without committing, run:
+
+```shell
+    pre-commit run --all-files
+```
+
+## Packages
+
+[uv](https://github.com/astral-sh/uv) is used for package management.  If
+you’ve introduced a new package to the source code (i.e. anywhere in `src/`),
+please add it to the `project.dependencies` section of `pyproject.toml` with
+any known version constraints.
+
+To add packages required only for testing, add them to the
+`[dependency-groups]`.
+
+Any changes to the dependencies will be automatically reflected in
+`uv.lock` with `pre-commit`, but you can re-generate the files without committing by
+executing:
+
+```shell
+    uv lock --upgrade
+```
+
+## Project
+
+[uv](https://github.com/astral-sh/uv) is used for project management. The project can be
+built using:
+
+```shell
+    uv build
+```
+
+Linting and syntax checking can be run with:
+
+```shell
+    uv run ruff check
+```
+
+To run the tests and view coverage, execute:
+
+```shell
+    uv run pytest
+```
+
+For the `test_ckan.py` test to run successfully, some configuration is required:
+
+1. The environment variable HDX_KEY_TEST needs to contain a valid key from the HDX demo
+server at https://demo.data-humdata-org.ahconu.org/
+1. Authentication details for Google Sheets need to be obtained and either saved in a
+file named `.gsheet_auth.json` in the home directory (~) or placed in an environment
+variable `GSHEET_AUTH`. The file is preferred for Windows systems since adding such a
+long text string to an environment variable in Windows is challenging.
+
+## Documentation
+
+The documentation, including API documentation, is generated using ReadtheDocs and
+MkDocs with Material. As you change the source code, remember to update the
+documentation at `documentation/index.md`.

hdx_python_api-6.6.6/README.md

@@ -0,0 +1,100 @@
+[![Build Status](https://github.com/OCHA-DAP/hdx-python-api/actions/workflows/run-python-tests.yaml/badge.svg)](https://github.com/OCHA-DAP/hdx-python-api/actions/workflows/run-python-tests.yaml)
+[![Coverage Status](https://coveralls.io/repos/github/OCHA-DAP/hdx-python-api/badge.svg?branch=main&ts=1)](https://coveralls.io/github/OCHA-DAP/hdx-python-api?branch=main)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Downloads](https://img.shields.io/pypi/dm/hdx-python-api.svg)](https://pypistats.org/packages/hdx-python-api)
+
+The HDX Python API Library is designed to enable you to easily develop code that
+interacts with the [Humanitarian Data Exchange](https://data.humdata.org/) (HDX)
+platform. The major goal of the library is to make pushing and pulling data from HDX as
+simple as possible for the end user.
+
+For more information, please read the
+[documentation](https://hdx-python-api.readthedocs.io/en/latest/).
+
+This library is part of the [Humanitarian Data Exchange](https://data.humdata.org/)
+(HDX) project. If you have humanitarian related data, please upload your datasets to
+HDX.
+
+# Development
+
+## Environment
+
+Development is currently done using Python 3.13. The environment can be created with:
+
+```shell
+    uv sync
+```
+
+This creates a .venv folder with the versions specified in the project's uv.lock file.
+
+### Pre-commit
+
+pre-commit will be installed when syncing uv. It is run every time you make a git
+commit if you call it like this:
+
+```shell
+    pre-commit install
+```
+
+With pre-commit, all code is formatted according to
+[ruff](https://docs.astral.sh/ruff/) guidelines.
+
+To check if your changes pass pre-commit without committing, run:
+
+```shell
+    pre-commit run --all-files
+```
+
+## Packages
+
+[uv](https://github.com/astral-sh/uv) is used for package management.  If
+you’ve introduced a new package to the source code (i.e. anywhere in `src/`),
+please add it to the `project.dependencies` section of `pyproject.toml` with
+any known version constraints.
+
+To add packages required only for testing, add them to the
+`[dependency-groups]`.
+
+Any changes to the dependencies will be automatically reflected in
+`uv.lock` with `pre-commit`, but you can re-generate the files without committing by
+executing:
+
+```shell
+    uv lock --upgrade
+```
+
+## Project
+
+[uv](https://github.com/astral-sh/uv) is used for project management. The project can be
+built using:
+
+```shell
+    uv build
+```
+
+Linting and syntax checking can be run with:
+
+```shell
+    uv run ruff check
+```
+
+To run the tests and view coverage, execute:
+
+```shell
+    uv run pytest
+```
+
+For the `test_ckan.py` test to run successfully, some configuration is required:
+
+1. The environment variable HDX_KEY_TEST needs to contain a valid key from the HDX demo
+server at https://demo.data-humdata-org.ahconu.org/
+1. Authentication details for Google Sheets need to be obtained and either saved in a
+file named `.gsheet_auth.json` in the home directory (~) or placed in an environment
+variable `GSHEET_AUTH`. The file is preferred for Windows systems since adding such a
+long text string to an environment variable in Windows is challenging.
+
+## Documentation
+
+The documentation, including API documentation, is generated using ReadtheDocs and
+MkDocs with Material. As you change the source code, remember to update the
+documentation at `documentation/index.md`.

{hdx_python_api-6.6.4 → hdx_python_api-6.6.6}/documentation/index.md

@@ -54,6 +54,8 @@ The library has detailed API documentation which can be found in the menu at the
 
 
 ## Breaking Changes
+From 6.6.5, removed DatasetTitleHelper class and Dataset method remove_dates_from_title
+
 From 6.6.0, Python 3.10 or later is required
 
 From 6.5.7, get_size_and_hash moved to HDX Python Utilities

{hdx_python_api-6.6.4 → hdx_python_api-6.6.6}/pyproject.toml

@@ -39,10 +39,9 @@ dependencies = [
     "ckanapi>=4.8",
     "defopt>=7.0.0",
     "email_validator",
-    "hdx-python-country>=4.0.1",
-    "hdx-python-utilities>=4.0.4",
+    "hdx-python-country>=4.1.1",
+    "hdx-python-utilities>=4.0.8",
     "makefun",
-    "quantulum3",
     "requests",
 ]
 
@@ -57,7 +56,7 @@ dev = [
     "pytest-cov",
     "pytest-mock",
     "pre-commit",
-    "ruff==0.14.13",
+    "ruff==0.14.14",
 ]
 
 [project.urls]

hdx_python_api-6.6.6/src/hdx/api/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '6.6.6'
+__version_tuple__ = version_tuple = (6, 6, 6)
+
+__commit_id__ = commit_id = None