2020-12-13 18:38:16 +01:00
< div align = "center" >
2020-12-13 18:39:59 +01:00
< img src = "https://raw.githubusercontent.com/akamhy/waybackpy/master/assets/waybackpy_logo.svg" > < br >
2020-12-13 18:38:16 +01:00
< / div >
2020-07-17 21:10:21 +02:00
2020-12-13 18:38:16 +01:00
-----------------
## Python package & CLI tool that interfaces with the Wayback Machine API.
[](https://pypi.org/project/waybackpy/)
[](https://github.com/akamhy/waybackpy/blob/master/LICENSE)
2021-01-02 06:40:23 +01:00
[](https://github.com/akamhy/waybackpy/actions?query=workflow%3ACI)
2020-07-26 06:54:31 +02:00
[](https://codecov.io/gh/akamhy/waybackpy)
2020-12-13 18:38:16 +01:00
[](https://github.com/akamhy/waybackpy/blob/master/CONTRIBUTING.md)
[](https://www.codacy.com/manual/akamhy/waybackpy?utm_source=github.com& utm_medium=referral& utm_content=akamhy/waybackpy& utm_campaign=Badge_Grade)
2020-11-11 06:14:14 +01:00
[](https://pepy.tech/project/waybackpy)
2020-05-05 15:38:26 +02:00
[](https://github.com/akamhy/waybackpy/releases)
2020-05-06 05:48:02 +02:00
[](https://codeclimate.com/github/akamhy/waybackpy/maintainability)
2020-05-05 06:01:43 +02:00
[](https://www.python.org/)
[](https://github.com/akamhy/waybackpy/graphs/commit-activity)
2020-12-13 18:38:16 +01:00
[](https://github.com/akamhy/waybackpy/commits/master)
2020-05-05 06:01:43 +02:00
2020-05-04 17:36:00 +02:00
2021-01-02 07:50:43 +01:00
## Table of contents
2020-05-05 05:33:16 +02:00
<!-- ts -->
2020-05-05 05:57:02 +02:00
2020-07-17 20:50:58 +02:00
* [Installation ](#installation )
2020-05-05 05:57:02 +02:00
2021-01-02 07:50:43 +01:00
* [Documentation and Wiki ](https://github.com/akamhy/waybackpy/wiki )
2020-05-05 05:57:02 +02:00
2020-07-17 20:50:17 +02:00
* [Tests ](#tests )
2020-05-05 05:57:02 +02:00
2020-10-02 21:46:19 +02:00
* [Packaging ](#packaging )
2020-07-18 13:00:20 +02:00
* [License ](#license )
2020-05-05 05:57:02 +02:00
2020-05-05 05:33:16 +02:00
<!-- te -->
2021-01-02 07:50:43 +01:00
### Installation
2020-10-02 20:04:06 +02:00
2020-05-04 17:36:00 +02:00
Using [pip ](https://en.wikipedia.org/wiki/Pip_(package_manager )):
2020-10-02 20:04:06 +02:00
2020-07-18 04:46:59 +02:00
```bash
pip install waybackpy
```
2020-10-02 20:04:06 +02:00
2020-07-22 18:05:02 +02:00
or direct from this repository using git.
2020-10-02 20:04:06 +02:00
2020-07-22 18:05:02 +02:00
```bash
pip install git+https://github.com/akamhy/waybackpy.git
```
2020-05-04 17:36:00 +02:00
2020-10-02 21:46:19 +02:00
2021-01-02 07:50:43 +01:00
### Tests
2020-10-17 08:31:49 +02:00
2020-10-16 19:07:32 +02:00
To run tests locally:
2020-10-17 08:31:49 +02:00
2020-12-13 18:38:16 +01:00
1) Install or update the testing/coverage tools
```bash
pip install codecov pytest pytest-cov -U
```
2) Inside the repository run the following commands
2020-10-16 19:07:32 +02:00
```bash
2020-12-13 18:38:16 +01:00
pytest --cov=waybackpy tests/
2020-10-16 19:07:32 +02:00
```
2020-12-13 18:38:16 +01:00
3) To report coverage run
```bash
bash < (curl -s https://codecov.io/bash) -t SECRET_CODECOV_TOKEN
```
You can find the tests [here ](https://github.com/akamhy/waybackpy/tree/master/tests ).
2021-01-02 07:50:43 +01:00
### Packaging
2020-10-02 18:40:30 +02:00
1. Increment version.
2. Build package ``python setup.py sdist bdist_wheel``.
3. Sign & upload the package ``twine upload -s dist/*``.
2020-05-04 17:36:00 +02:00
## License
2020-10-02 20:04:06 +02:00
2020-10-02 18:40:30 +02:00
Released under the MIT License. See
[license ](https://github.com/akamhy/waybackpy/blob/master/LICENSE ) for details.
