Home

What is waybackpy?

waybackpy is an open-source python package & command-line tool that interfaces with the Internet Archive's Wayback Machine API.

Documentation

waybackpy can be used as a python library and a CLI application. Choose one of the following pages based on your requirements.

• Use as a Python package

• Use as a Command-line interface tool

Cite

To cite waybackpy visit https://doi.org/10.5281/zenodo.3977276.

Tests

To run tests locally:

1. Install or update the testing/coverage tools

pip install codecov pytest pytest-cov -U

2. Inside the repository run the following commands

pytest --cov=waybackpy tests/

3. To report coverage run

bash <(curl -s https://codecov.io/bash) -t SECRET_CODECOV_TOKEN

You can find the tests here.

Packaging

1. Increment version in waybackpy/waybackpy/__version__.py.

2. Change the download_url in waybackpy/setup.py.

3. Create release at https://github.com/akamhy/waybackpy/releases/new, fill the incremented version in 'Tag version' and version prepended with 'v' in 'Release Title'.
   Fill 'Describe the Release' with changes made and features added. Finally, hit the green 'Publish Release' button.

4. The workflow at https://github.com/akamhy/waybackpy/blob/master/.github/workflows/python-publish.yml will do the rest for you.

License

waybackpy is released under the MIT License.