Download images from IIIF manifests
This repository contains code to download images from IIIF manifests. It takes into account limitations and data specificities from various institutions.
pip install iiif-download
Basic usage
The configuration is stored in iiif_download/config.py and can be overridden by setting environment variables.
Inside a script
from iiif_download import IIIFManifest, config, Config
# Override the default configuration
config.max_size = 2500
config.img_dir = "custom/path/to/images"
manifest_url = "https://example.org/manifest"
# Use global config
manifest = IIIFManifest(manifest_url)
# or override the global config for a specific manifest
manifest = IIIFManifest(
manifest_url,
# surcharge any global attribute locally
img_dir="path/to/dir",
max_size=4000
)
# or define another config
manifest = IIIFManifest(manifest_url, config=Config(is_logged=False))
# Download images from a manifest inside img_dir/dir_name
manifest.download(save_dir="dir_name")
Command line
# override specific variables
export IIIF_IMG_DIR=custom/path/to/images
export IIIF_MAX_SIZE=4000
export IIIF_DEBUG=True
# or use .env
source .env
iiif-download https://example.org/manifest
iiif-download -f test-manifests.txt
iiif-download -d custom/path/to/images https://example.org/manifest
Metadata extraction
from iiif_download import IIIFManifest
manifest = IIIFManifest("https://example.org/manifest")
manifest.load()
lic = manifest.license
author = manifest.get_meta("author")
images = manifest.images
Development
Install locally
python -m venv venv && source venv/bin/activate
pip install -e ".[dev]"
Run tests
pytest
# pre-commit install
pre-commit run --all-files
Publish on PyPi
git tag v<*.*.*> && git push origin v<*.*.*>
1 maintainer
Release files for iiif-download 0.1.18
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| iiif_download-0.1.18.tar.gz | 26.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| iiif_download-0.1.18-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 52.5 kB
Release files / iiif_download-0.1.18.tar.gz
| Download URL | iiif_download-0.1.18.tar.gz |
|---|---|
| Size | 26.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
61f729ec67ec8d35189429a5595e391ef18d3f38d4bc20ccc5331c3c740528a4
|
|
BLAKE2b-256 checksum How to use checksums |
2d0ff6aad2cf23fd7774a11591330ca03882cd66c1fbec110449d65eb1970d83
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 12, 2026.
Transparency logRelease files / iiif_download-0.1.18-py3-none-any.whl
| Download URL | iiif_download-0.1.18-py3-none-any.whl |
|---|---|
| Size | 26.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
eddff0db471bdb96b84032c3fd106144ce9057b3be88d3443ccb1a84b2ebd29a
|
|
BLAKE2b-256 checksum How to use checksums |
b5c23b11b47968199e8037a5b076e367b7111ee6c95b557e1cb4c13344e60df2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 12, 2026.
Transparency log
