-
Notifications
You must be signed in to change notification settings - Fork 34
Home
waybackpy (pronounced way-back-py or way-back-pee) is an open-source python package & command-line tool that interfaces with the Internet Archive's Wayback Machine API.
waybackpy can be used as a python library and a CLI application. Choose one of the following pages based on your requirements.
- Any contributions you make will be under the MIT License.
- Read CONTRIBUTING.md
- To lint automatically you can install black and run
black .on the repository root. - You may actually skip writing tests and linting :) I will write them for you!
- Make sure that your changes pass the testing, read the following section to test your changes.
- Wayback Machine API ain't much reliable, if your tests fails check if it's really because of your changes.
test locally in two simple steps:
- Install/update the testing/coverage tools
pip install codecov pytest pytest-cov -U- In repository root, run
pytest --cov=waybackpy tests/You can find the tests here.
-
Increment version in
waybackpy/waybackpy/__version__.py. -
Change the download_url in
waybackpy/setup.py. -
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. -
The workflow at https://github.com/akamhy/waybackpy/blob/master/.github/workflows/python-publish.yml will do the rest for you.
waybackpy is released under the MIT License.