Unified, type-safe access to web archive APIs.

Install the package from PyPI:

pip install web-archive-api

Web archives offer two main APIs: the CDX API to list available captures and the Memento API to download individual captures.

TODO

TODO

To build this package and contribute to its development you need to install the build, and setuptools and wheel packages:

pip install build setuptools wheel

(On most systems, these packages are already pre-installed.)

Install package and test dependencies:

pip install -e .[tests]

Verify your changes against the test suite to verify.

flake8 web_archive_api  # Code format
mypy web_archive_api    # Static typing
pylint web_archive_api  # LINT errors
bandit -c pyproject.toml -r web_archive_api  # Security
pytest web_archive_api  # Unit tests

Please also add tests for your newly developed code.

Wheels for this package can be built with:

python -m build

If you hit any problems using this package, please file an issue. We're happy to help!

This repository is released under the MIT license.