The HDX Python Utilities Library provides a range of helpful utilities for Python developers. Note that these are not specific to HDX.
- Easy downloading of files with support for authentication, streaming and hashing
- Retrieval of data from url with saving to file or from data previously saved
- Date utilities
- Loading and saving JSON and YAML (maintaining order)
- Dictionary and list utilities
- HTML utilities (inc. BeautifulSoup helper)
- Compare files (eg. for testing)
- Simple emailing
- Easy logging setup and error logging
- State utility
- Path utilities
- URL utilities
- Text processing
- Stable file hashing
- Matching utilities
- Encoding utilities
- Check valid UUID
- Easy building and packaging
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
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.
1 maintainer
Metadata
1 maintainer
Release files for hdx-python-utilities 4.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hdx_python_utilities-4.2.1.tar.gz | 2.2 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hdx_python_utilities-4.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.2 MB
Release files / hdx_python_utilities-4.2.1.tar.gz
| Download URL | hdx_python_utilities-4.2.1.tar.gz |
|---|---|
| Size | 2.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
12dd377a70cd86ee6357576965b5a69a4b4649d3546159d8e5da6c1767bed63e
|
|
BLAKE2b-256 checksum How to use checksums |
944250dfa59e3c8d6d76f522e02699b3f14e2017565bc323930e745ced9d5c08
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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}
|
Release files / hdx_python_utilities-4.2.1-py3-none-any.whl
| Download URL | hdx_python_utilities-4.2.1-py3-none-any.whl |
|---|---|
| Size | 68.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
982f0bef161bed60f4527e2fc7accdbb1fb638ecdf7e63fb5fb6084cb9866c77
|
|
BLAKE2b-256 checksum How to use checksums |
c3f1f6f4fea07d2582418f85cb867c16d28aceea1538b9a561b33fa301319375
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.0 {"installer":{"name":"uv","version":"0.13.0","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}
|
