Update index.rst

This commit is contained in:
Akash Mahanty
2020-12-13 22:28:20 +05:30
committed by GitHub
parent 9cff8ca4aa
commit 07d9137ef8

View File

@@ -1,27 +1,12 @@
.. raw:: html
<div align="center">
<img src="https://raw.githubusercontent.com/akamhy/waybackpy/improve-appearance-of-readme/assets/waybackpy_logo.svg"><br>
</div>
-------------- --------------
Python package & CLI tool that interfaces with the Wayback Machine API. Python package & CLI tool that interfaces with the Wayback Machine API.
----------------------------------------------------------------------- -----------------------------------------------------------------------
| |pypi| |pypi| |License: MIT| |Build Status| |codecov| |contributions welcome|
| |License: MIT| |Codacy Badge| |Downloads| |Release| |Maintainability|
| |Build Status| |made-with-python| |Maintenance| |GitHub last commit| |PyPI - Python
| |codecov| Version|
| |contributions welcome|
| |Codacy Badge|
| |Downloads|
| |Release|
| |Maintainability|
| |made-with-python|
| |Maintenance|
| |GitHub last commit|
| |PyPI - Python Version|
Table of contents Table of contents
================= =================
@@ -320,10 +305,10 @@ https://repl.it/@akamhy/WaybackPyTotalArchivesExample\
List of URLs that Wayback Machine knows and has archived for a domain name List of URLs that Wayback Machine knows and has archived for a domain name
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| 1) If alive=True is set, waybackpy will check all URLs to identify the 1) If alive=True is set, waybackpy will check all URLs to identify the
alive URLs. Don't use with popular websites like google or it would take alive URLs. Don't use with popular websites like google or it would
too long. take too long.
| 2) To include URLs from subdomain set sundomain=True 2) To include URLs from subdomain set sundomain=True
.. code:: python .. code:: python
@@ -445,11 +430,11 @@ https://repl.it/@akamhy/WaybackPyBashGet\
Fetch all the URLs that the Wayback Machine knows for a domain Fetch all the URLs that the Wayback Machine knows for a domain
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| 1) You can add the '--alive' flag to only fetch alive links. 1) You can add the '--alive' flag to only fetch alive links.
| 2) You can add the '--subdomain' flag to add subdomains. 2) You can add the '--subdomain' flag to add subdomains.
| 3) '--alive' and '--subdomain' flags can be used simultaneously. 3) '--alive' and '--subdomain' flags can be used simultaneously.
| 4) All links will be saved in a file, and the file will be created in 4) All links will be saved in a file, and the file will be created in
the current working directory. the current working directory.
.. code:: bash .. code:: bash
@@ -504,17 +489,17 @@ You can find the tests
Packaging Packaging
--------- ---------
#. Increment version. 1. Increment version.
#. Build package ``python setup.py sdist bdist_wheel``. 2. Build package ``python setup.py sdist bdist_wheel``.
#. Sign & upload the package ``twine upload -s dist/*``. 3. Sign & upload the package ``twine upload -s dist/*``.
License License
------- -------
| Released under the MIT License. See 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.
.. |pypi| image:: https://img.shields.io/pypi/v/waybackpy.svg .. |pypi| image:: https://img.shields.io/pypi/v/waybackpy.svg