DataCache
Download, verify, transform, and cache datasets for Python applications, including OpenVax libraries such as pyensembl. DataCache provides streaming downloads, gzip/ZIP decompression, transactional tar-tree installation, reusable local paths, offline inspection, and SQLite caches built from pandas DataFrames.
Install
Python 3.9 or newer is required.
python -m pip install datacache
# Optional HTML-table conversion:
python -m pip install "datacache[html]"
tqdm is installed by default; existing download APIs enable displays with
show_progress=True, while materialize enables them by default. Quiet use
does not import tqdm or configure your
application's logging. The old datacache[progress] install syntax remains
supported as a compatibility alias.
The existing pandas dependency range is unchanged; upgrading DataCache does not introduce a pandas 1.5 requirement. CI covers pandas 1.4.4, 1.5.3, and current releases on supported Python versions.
Quickstart
Download a file once, then reuse its local path on later calls:
from datacache import Cache
cache = Cache("my-project")
url = "https://raw.githubusercontent.com/openvax/datacache/master/LICENSE"
path = cache.fetch(url, filename="LICENSE", timeout=30)
print(path)
# Reuses the cached file without a network request, even in a later process.
assert cache.fetch(url, filename="LICENSE") == path
Replace the URL and filename with your dataset. Existing files are reused until
you refresh them with force=True, or periodically with expire_after;
DataCache doesn't ask the server whether a file has changed. Add
show_progress=True to display a download bar; no extra installation is needed.
Guides
Sections that earlier versions of this README contained now live in these guides; their old links land on the guide that replaced them.
- Working offline example, verification and interface choices
- Downloads, inspection, integrity, freshness, retries and resumption
- Tables, SQLite and transformations
- Shared caches
- Progress and logging
- Pinned bundles, archive trees and the legacy file registry
- Interface selection and guarantees
- Derived-artifact materialization: caller-owned builders, outputs published together as one bundle, dependency receipts and resumable inputs.
- Complete API reference
- Downstream integration: contracts for consuming libraries.
- Release notes and release procedure.
Development
python -m pip install -e ".[test]"
./lint-and-test.sh
python -m examples.basic_usage
Tests use local files, mocked responses, and local HTTP servers. They do not depend on external dataset servers. See CI for the Python, dependency, and operating-system combinations exercised.
Build the site with python -m pip install -r requirements-docs.txt and ./docs.sh.
5 maintainers
Metadata
5 maintainers
Release files for datacache 1.20.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| datacache-1.20.0.tar.gz | 226.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| datacache-1.20.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 314.9 kB
Release files / datacache-1.20.0.tar.gz
| Download URL | datacache-1.20.0.tar.gz |
|---|---|
| Size | 226.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1886c174c5fc330b90f7afbe3766eaadb8cc856a0d787f6afa06eacdc465f3c2
|
|
BLAKE2b-256 checksum How to use checksums |
d7f9c5fdaf69d03eed956f1bcd91e23cc9a263d691e2d03b377d4ccad3ffdbc6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.6
|
Release files / datacache-1.20.0-py3-none-any.whl
| Download URL | datacache-1.20.0-py3-none-any.whl |
|---|---|
| Size | 88.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
af27665555e065cda7997dab12795fe18ebb16d39b8b1f365fba04000b3e3c4c
|
|
BLAKE2b-256 checksum How to use checksums |
2b137d0fe8a279366e5a2f2224edeaa8f6c95c4bda0eedefe524bc08fada0f46
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.6
|
