HDX Python API for interacting with the Humanitarian Data Exchange

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mcarans from gravatar.com mcarans

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (MIT)
  • Author: Michael Rans
  • Tags API , CKAN , HDX , humanitarian data exchange
  • Requires: Python >=3.10
  • Provides-Extra: docs
Classifiers
Report project as malware

Project description

Build Status Coverage Status Ruff Downloads

The HDX Python API Library is designed to enable you to easily develop code that interacts with the Humanitarian Data Exchange (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.

This library is part of the Humanitarian Data Exchange (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:

    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:

    pre-commit install

With pre-commit, all code is formatted according to ruff guidelines.

To check if your changes pass pre-commit without committing, run:

    pre-commit run --all-files

Packages

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:

    uv lock --upgrade

Project

uv is used for project management. The project can be built using:

    uv build

Linting and syntax checking can be run with:

    uv run ruff check

To run the tests and view coverage, execute:

    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/
  2. 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.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mcarans from gravatar.com mcarans

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License (MIT)
  • Author: Michael Rans
  • Tags API , CKAN , HDX , humanitarian data exchange
  • Requires: Python >=3.10
  • Provides-Extra: docs
Classifiers

Release history Release notifications | RSS feed

This version

6.6.7

6.6.6

6.6.5

6.6.4

6.6.3

6.6.1

6.6.0

6.5.7

6.5.6

6.5.5

6.5.4

6.5.3

6.5.2

6.5.1

6.5.0

6.4.7

6.4.6

6.4.5

6.4.4

6.4.3

6.4.2

6.4.1

6.4.0

6.3.9

6.3.8

6.3.7

6.3.6

6.3.5

6.3.4

6.3.3

6.3.2

6.3.1

6.3.0

6.2.9

6.2.8

6.2.7

6.2.6

6.2.5

6.2.4

6.2.3

6.2.2

6.2.1

6.2.0

6.1.4

6.1.3

6.1.2

6.1.1

6.1.0

6.0.9

6.0.8

6.0.7

6.0.6

6.0.5

6.0.4

6.0.2

6.0.1

6.0.0

5.9.9

5.9.8

5.9.7

5.9.6

5.9.5

5.9.4

5.9.3

5.9.2

5.9.1

5.9.0

5.8.9

5.8.8

5.8.7

5.8.6

5.8.5

5.8.4

5.8.3

5.8.2

5.8.1

5.8.0

5.7.9

5.7.8

5.7.7

5.7.6

5.7.5

5.7.4

5.7.3

5.7.2

5.7.1

5.7.0

5.6.9

5.6.8

5.6.7

5.6.6

5.6.5

5.6.4

5.6.3

5.6.2

5.6.1

5.6.0

5.5.9

5.5.8

5.5.7

5.5.6

5.5.5

5.5.4

5.5.3

5.5.2

5.5.1

5.5.0

5.4.9

5.4.8

5.4.7

5.4.6

5.4.5

5.4.4

5.4.3

5.4.2

5.4.1

5.4.0

5.3.3

5.3.2

5.3.1

5.3.0

5.2.7

5.2.6

5.2.5

5.2.4

5.2.3

5.2.2

5.2.1

5.2.0

5.1.9

5.1.8

5.1.7

5.1.6

5.1.5

5.1.4

5.1.3

5.1.2

5.1.1

5.1.0

5.0.9

5.0.8

5.0.7

5.0.6

5.0.5

5.0.4

5.0.3

5.0.2

5.0.1

5.0.0

4.9.9

4.9.8

4.9.7

4.9.6

4.9.5

4.9.4

4.9.3

4.9.2

4.9.1

4.9.0

4.8.9

4.8.8

4.8.7

4.8.6

4.8.5

4.8.4

4.8.3

4.8.2

4.8.1

4.8.0

4.7.9

4.7.8

4.7.7

4.7.6

4.7.5

4.7.4

4.7.3

4.7.2

4.7.1

4.7.0

4.6.9

4.6.8

4.6.7

4.6.6

4.6.5

4.6.4

4.6.3

4.6.2

4.6.1

4.6.0

4.5.9

4.5.8

4.5.7

4.5.6

4.5.5

4.5.4

4.5.3

4.5.2

4.5.0

4.4.9

4.4.8

4.4.7

4.4.6

4.4.5

4.4.4

4.4.3

4.4.2

4.4.1

4.4.0

4.3.9

4.3.8

4.3.7

4.3.6

4.3.5

4.3.4

4.3.3

4.3.2

4.3.1

4.3.0

4.2.9

4.2.8

4.2.7

4.2.6

4.2.5

4.2.4

4.2.3

4.2.2

4.2.1

4.2.0

4.1.9

4.1.8

4.1.7

4.1.6

4.1.5

4.1.4

4.1.3

4.1.2

4.1.1

4.1.0

4.0.9

4.0.8

4.0.7

4.0.6

4.0.5

4.0.4

4.0.3

4.0.2

4.0.1

4.0.0

3.9.9

3.9.8

3.9.7

3.9.6

3.9.5

3.9.4

3.9.3

3.9.2

3.9.1

3.9.0

3.8.9

3.8.8

3.8.7

3.8.6

3.8.5

3.8.4

3.8.3

3.8.2

3.8.1

3.8.0

3.7.9

3.7.8

3.7.7

3.7.6

3.7.5

3.7.4

3.7.3

3.7.2

3.7.1

3.7.0

3.6.9

3.6.8

3.6.7

3.6.6

3.6.5

3.6.4

3.6.3

3.6.2

3.6.1

3.6.0

3.5.9

3.5.8

3.5.7

3.5.6

3.5.5

3.5.4

3.5.3

3.5.2

3.5.1

3.5.0

3.4.9

3.4.8

3.4.7

3.4.6

3.4.5

3.4.4

3.4.3

3.4.2

3.4.1

3.4.0

3.3.9

3.3.8

3.3.7

3.3.6

3.3.5

3.3.4

3.3.3

3.3.2

3.3.1

3.3.0

3.2.9

3.2.8

3.2.7

3.2.6

3.2.5

3.2.4

3.2.3

3.2.2

3.2.1

3.2.0

3.1.9

3.1.8

3.1.7

3.1.6

3.1.5

3.1.4

3.1.3

3.1.2

3.1.1

3.1.0

3.0.9

3.0.7

3.0.6

3.0.5

3.0.4

3.0.3

3.0.2

3.0.1

3.0.0

2.9.9

2.9.8

2.9.7

2.9.6

2.9.5

2.9.4

2.9.3

2.9.2

2.9.1

2.9.0

2.8.9

2.8.8

2.8.7

2.8.6

2.8.5

2.8.4

2.8.3

2.8.2

2.8.1

2.8.0

2.7.9

2.7.8

2.7.7

2.7.6

2.7.5

2.7.4

2.7.3

2.7.2

2.7.1

2.7.0

2.6.9

2.6.8

2.6.7

2.6.6

2.6.5

2.6.4

2.6.3

2.6.2

2.6.0

2.5.9

2.5.8

2.5.7

2.5.6

2.5.5

2.5.4

2.5.3

2.5.2

2.5.1

2.5.0

2.4.9

2.4.8

2.4.7

2.4.5

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0

2.3.8

2.3.7

2.3.6

2.3.5

2.3.4

2.3.3

2.3.2

2.3.1

2.3.0

2.2.8

2.2.7

2.2.6

2.2.5

2.2.4

2.2.3

2.2.2

2.2.1

2.2.0

2.1.9

2.1.8

2.1.7

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.0

1.4.2

1.4.1

1.4

1.3.1

1.3.0

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.3

1.1.2

1.1.1

1.1.0

1.0.6

1.0.5

1.0.1

1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hdx_python_api-6.6.7.tar.gz (523.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hdx_python_api-6.6.7-py3-none-any.whl (70.5 kB view details)

Uploaded Python 3

File details

Details for the file hdx_python_api-6.6.7.tar.gz.

File metadata

  • Download URL: hdx_python_api-6.6.7.tar.gz
  • Upload date:
  • Size: 523.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for hdx_python_api-6.6.7.tar.gz
Algorithm Hash digest
SHA256 69270a6ccb9ce3cd033446d3b9919a715f491cea0469e6918ecf271daae81d3d
MD5 0d9d2f0f73693c7ef5a48ddaf0663458
BLAKE2b-256 131847bc34144f7a46299b2eb3951da2b84fdb6069229f8928131ccf28d918a7

See more details on using hashes here.

File details

Details for the file hdx_python_api-6.6.7-py3-none-any.whl.

File metadata

  • Download URL: hdx_python_api-6.6.7-py3-none-any.whl
  • Upload date:
  • Size: 70.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.3 {"installer":{"name":"uv","version":"0.11.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for hdx_python_api-6.6.7-py3-none-any.whl
Algorithm Hash digest
SHA256 7dedf97e69cf16e9eaf0cff1d02be13c7daba0d390baacabd30ddbaecab7d4f6
MD5 9537a484c3ebc33850a5d758aa6a6e64
BLAKE2b-256 d298d913ac3cf8f37dfd5bc16fdb0ce67d47cc0bf0236a56d397bf96e4099224

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page