92 lines
3.1 KiB
Markdown
92 lines
3.1 KiB
Markdown
<div align="center">
|
|
<img src="https://raw.githubusercontent.com/akamhy/waybackpy/master/assets/waybackpy_logo.svg"><br>
|
|
</div>
|
|
|
|
-----------------
|
|
|
|
## Python package & CLI tool that interfaces with the Wayback Machine API.
|
|
[](https://pypi.org/project/waybackpy/)
|
|
[](https://github.com/akamhy/waybackpy/blob/master/LICENSE)
|
|
[](https://github.com/akamhy/waybackpy/actions?query=workflow%3ACI)
|
|
[](https://codecov.io/gh/akamhy/waybackpy)
|
|
[](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)
|
|
[](https://pepy.tech/project/waybackpy)
|
|
[](https://github.com/akamhy/waybackpy/releases)
|
|
[](https://codeclimate.com/github/akamhy/waybackpy/maintainability)
|
|
[](https://www.python.org/)
|
|
[](https://github.com/akamhy/waybackpy/graphs/commit-activity)
|
|
[](https://github.com/akamhy/waybackpy/commits/master)
|
|
|
|
|
|
|
|
|
|
## Table of contents
|
|
|
|
<!--ts-->
|
|
|
|
* [Installation](#installation)
|
|
|
|
* [Documentation and Wiki](https://github.com/akamhy/waybackpy/wiki)
|
|
|
|
* [Tests](#tests)
|
|
|
|
* [Packaging](#packaging)
|
|
|
|
* [License](#license)
|
|
|
|
<!--te-->
|
|
|
|
### Installation
|
|
|
|
Using [pip](https://en.wikipedia.org/wiki/Pip_(package_manager)):
|
|
|
|
```bash
|
|
pip install waybackpy
|
|
```
|
|
|
|
or direct from this repository using git.
|
|
|
|
```bash
|
|
pip install git+https://github.com/akamhy/waybackpy.git
|
|
```
|
|
|
|
|
|
### Tests
|
|
|
|
To run tests locally:
|
|
|
|
1) Install or update the testing/coverage tools
|
|
|
|
```bash
|
|
pip install codecov pytest pytest-cov -U
|
|
```
|
|
|
|
2) Inside the repository run the following commands
|
|
|
|
```bash
|
|
pytest --cov=waybackpy tests/
|
|
```
|
|
|
|
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).
|
|
|
|
|
|
### 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](https://github.com/akamhy/waybackpy/blob/master/LICENSE) for details.
|