Update index.rst
This commit is contained in:
Akash Mahanty
GitHub
94
index.rst
94
index.rst
@@ -1,18 +1,20 @@
|
|||||||
waybackpy
|
.. raw:: html
|
||||||
=========
|
|
||||||
|
|
||||||
|contributions welcome| |Build Status| |codecov| |Downloads| |Release|
|
<div align="center">
|
||||||
|Codacy Badge| |Maintainability| |CodeFactor| |made-with-python| |pypi|
|
|
||||||
|PyPI - Python Version| |Maintenance| |Repo size| |License: MIT|
|
|
||||||
|
|
||||||
.. figure:: https://raw.githubusercontent.com/akamhy/waybackpy/master/assets/waybackpy-colored%20284.png
|
.. raw:: html
|
||||||
:alt: Wayback Machine
|
|
||||||
|
|
||||||
Wayback Machine
|
</div>
|
||||||
Waybackpy is a Python package that interfaces with `Internet
|
|
||||||
Archive <https://en.wikipedia.org/wiki/Internet_Archive>`__'s `Wayback
|
--------------
|
||||||
Machine <https://en.wikipedia.org/wiki/Wayback_Machine>`__ API. Archive
|
|
||||||
webpages and retrieve archived webpages easily.
|
Python package & CLI tool that interfaces with the Wayback Machine API.
|
||||||
|
-----------------------------------------------------------------------
|
||||||
|
|
||||||
|
|pypi| |License: MIT| |Build Status| |codecov| |contributions welcome|
|
||||||
|
|Codacy Badge| |Downloads| |Release| |Maintainability|
|
||||||
|
|made-with-python| |Maintenance| |GitHub last commit| |PyPI - Python
|
||||||
|
Version|
|
||||||
|
|
||||||
Table of contents
|
Table of contents
|
||||||
=================
|
=================
|
||||||
@@ -469,18 +471,28 @@ https://repl.it/@akamhy/WaybackpyKnownUrlsFromWaybackMachine#main.sh\
|
|||||||
Tests
|
Tests
|
||||||
-----
|
-----
|
||||||
|
|
||||||
`Here <https://github.com/akamhy/waybackpy/tree/master/tests>`__
|
|
||||||
|
|
||||||
To run tests locally:
|
To run tests locally:
|
||||||
|
|
||||||
|
1) Install or update the testing/coverage tools
|
||||||
|
|
||||||
.. code:: bash
|
.. code:: bash
|
||||||
|
|
||||||
pip install -U pytest
|
pip install codecov pytest pytest-cov -U
|
||||||
pip install codecov
|
|
||||||
pip install pytest pytest-cov
|
2) Inside the repository run the following commands
|
||||||
cd tests
|
|
||||||
pytest --cov=../waybackpy
|
.. code:: bash
|
||||||
python -m codecov #For reporting coverage on Codecov
|
|
||||||
|
pytest --cov=waybackpy tests/
|
||||||
|
|
||||||
|
3) To report coverage run
|
||||||
|
|
||||||
|
.. code:: 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
|
Packaging
|
||||||
---------
|
---------
|
||||||
@@ -498,28 +510,28 @@ Released under the MIT License. See
|
|||||||
`license <https://github.com/akamhy/waybackpy/blob/master/LICENSE>`__
|
`license <https://github.com/akamhy/waybackpy/blob/master/LICENSE>`__
|
||||||
for details.
|
for details.
|
||||||
|
|
||||||
.. |contributions welcome| image:: https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square
|
|
||||||
.. |Build Status| image:: https://img.shields.io/travis/akamhy/waybackpy.svg?label=Travis%20CI&logo=travis&style=flat-square
|
|
||||||
:target: https://travis-ci.org/akamhy/waybackpy
|
|
||||||
.. |codecov| image:: https://codecov.io/gh/akamhy/waybackpy/branch/master/graph/badge.svg
|
|
||||||
:target: https://codecov.io/gh/akamhy/waybackpy
|
|
||||||
.. |Downloads| image:: https://pepy.tech/badge/waybackpy/month
|
|
||||||
:target: https://pepy.tech/project/waybackpy/month
|
|
||||||
.. |Release| image:: https://img.shields.io/github/v/release/akamhy/waybackpy.svg
|
|
||||||
:target: https://github.com/akamhy/waybackpy/releases
|
|
||||||
.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/255459cede9341e39436ec8866d3fb65
|
|
||||||
:target: https://www.codacy.com/manual/akamhy/waybackpy?utm_source=github.com&utm_medium=referral&utm_content=akamhy/waybackpy&utm_campaign=Badge_Grade
|
|
||||||
.. |Maintainability| image:: https://api.codeclimate.com/v1/badges/942f13d8177a56c1c906/maintainability
|
|
||||||
:target: https://codeclimate.com/github/akamhy/waybackpy/maintainability
|
|
||||||
.. |CodeFactor| image:: https://www.codefactor.io/repository/github/akamhy/waybackpy/badge
|
|
||||||
:target: https://www.codefactor.io/repository/github/akamhy/waybackpy
|
|
||||||
.. |made-with-python| image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg
|
|
||||||
:target: https://www.python.org/
|
|
||||||
.. |pypi| image:: https://img.shields.io/pypi/v/waybackpy.svg
|
.. |pypi| image:: https://img.shields.io/pypi/v/waybackpy.svg
|
||||||
:target: https://pypi.org/project/waybackpy/
|
:target: https://pypi.org/project/waybackpy/
|
||||||
.. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/waybackpy?style=flat-square
|
|
||||||
.. |Maintenance| image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg
|
|
||||||
:target: https://github.com/akamhy/waybackpy/graphs/commit-activity
|
|
||||||
.. |Repo size| image:: https://img.shields.io/github/repo-size/akamhy/waybackpy.svg?label=Repo%20size&style=flat-square
|
|
||||||
.. |License: MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
|
.. |License: MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
|
||||||
:target: https://github.com/akamhy/waybackpy/blob/master/LICENSE
|
:target: https://github.com/akamhy/waybackpy/blob/master/LICENSE
|
||||||
|
.. |Build Status| image:: https://github.com/akamhy/waybackpy/workflows/CI/badge.svg
|
||||||
|
:target: https://github.com/akamhy/waybackpy/actions
|
||||||
|
.. |codecov| image:: https://codecov.io/gh/akamhy/waybackpy/branch/master/graph/badge.svg
|
||||||
|
:target: https://codecov.io/gh/akamhy/waybackpy
|
||||||
|
.. |contributions welcome| image:: https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square
|
||||||
|
:target: https://github.com/akamhy/waybackpy/blob/master/CONTRIBUTING.md
|
||||||
|
.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/255459cede9341e39436ec8866d3fb65
|
||||||
|
:target: https://www.codacy.com/manual/akamhy/waybackpy?utm_source=github.com&utm_medium=referral&utm_content=akamhy/waybackpy&utm_campaign=Badge_Grade
|
||||||
|
.. |Downloads| image:: https://pepy.tech/badge/waybackpy/month
|
||||||
|
:target: https://pepy.tech/project/waybackpy
|
||||||
|
.. |Release| image:: https://img.shields.io/github/v/release/akamhy/waybackpy.svg
|
||||||
|
:target: https://github.com/akamhy/waybackpy/releases
|
||||||
|
.. |Maintainability| image:: https://api.codeclimate.com/v1/badges/942f13d8177a56c1c906/maintainability
|
||||||
|
:target: https://codeclimate.com/github/akamhy/waybackpy/maintainability
|
||||||
|
.. |made-with-python| image:: https://img.shields.io/badge/Made%20with-Python-1f425f.svg
|
||||||
|
:target: https://www.python.org/
|
||||||
|
.. |Maintenance| image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg
|
||||||
|
:target: https://github.com/akamhy/waybackpy/graphs/commit-activity
|
||||||
|
.. |GitHub last commit| image:: https://img.shields.io/github/last-commit/akamhy/waybackpy?color=blue&style=flat-square
|
||||||
|
:target: https://github.com/akamhy/waybackpy/commits/master
|
||||||
|
.. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/waybackpy?style=flat-square
|
||||||
|
|||||||
Reference in New Issue
Block a user