----------------- ## Python package & CLI tool that interfaces with the Wayback Machine API. [![pypi](https://img.shields.io/pypi/v/waybackpy.svg)](https://pypi.org/project/waybackpy/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/akamhy/waybackpy/blob/master/LICENSE) [![Build Status](https://github.com/akamhy/waybackpy/workflows/CI/badge.svg)](https://github.com/akamhy/waybackpy/actions?query=workflow%3ACI) [![codecov](https://codecov.io/gh/akamhy/waybackpy/branch/master/graph/badge.svg)](https://codecov.io/gh/akamhy/waybackpy) [![contributions welcome](https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square)](https://github.com/akamhy/waybackpy/blob/master/CONTRIBUTING.md) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/255459cede9341e39436ec8866d3fb65)](https://www.codacy.com/manual/akamhy/waybackpy?utm_source=github.com&utm_medium=referral&utm_content=akamhy/waybackpy&utm_campaign=Badge_Grade) [![Downloads](https://pepy.tech/badge/waybackpy/month)](https://pepy.tech/project/waybackpy) [![Release](https://img.shields.io/github/v/release/akamhy/waybackpy.svg)](https://github.com/akamhy/waybackpy/releases) [![Maintainability](https://api.codeclimate.com/v1/badges/942f13d8177a56c1c906/maintainability)](https://codeclimate.com/github/akamhy/waybackpy/maintainability) [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/akamhy/waybackpy/graphs/commit-activity) [![GitHub last commit](https://img.shields.io/github/last-commit/akamhy/waybackpy?color=blue&style=flat-square)](https://github.com/akamhy/waybackpy/commits/master) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/waybackpy?style=flat-square) ## Table of contents * [Installation](#installation) * [Documentation and Wiki](https://github.com/akamhy/waybackpy/wiki) * [Tests](#tests) * [Packaging](#packaging) * [License](#license) ### 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.