waybackpy/README.md

---

Python package & CLI tool that interfaces with the Wayback Machine API.

Table of contents

• Installation

• Documentation and Wiki

• Tests

• Packaging

• License

Installation

Using pip:

pip install waybackpy

or direct from this repository using git.

pip install git+https://github.com/akamhy/waybackpy.git

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.

2. Build package python setup.py sdist bdist_wheel.

3. Sign & upload the package twine upload -s dist/*.

License

Released under the MIT License. See license for details.