web-archive-api 0.1.0

Unified, type-safe access to web archive APIs.

🗃️ web-archive-api

Unified, type-safe access to web archive APIs.

Installation

Install the package from PyPI:

pip install web-archive-api

Usage

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

CDX API

TODO

Memento API

TODO

Development

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.)

Installation

Install package and test dependencies:

pip install -e .[tests]

Testing

Verify your changes against the test suite to verify.

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

Please also add tests for your newly developed code.

Build wheels

Wheels for this package can be built with:

python -m build

Support

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

License

This repository is released under the MIT license.