Benjamin_Loison/waybackpy
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

remove useless external links form the README lead

Browse Source 
and also added a line about the recentness of the newest method between the availability and CDX server API.
This commit is contained in:
Akash Mahanty
2022-03-15 20:13:29 +05:30
committed by GitHub
parent 7930cacedf
commit eda3c90f72
1 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -22,15 +22,15 @@
# <img src="https://github.githubassets.com/images/icons/emoji/unicode/2b50.png" width="30"></img> Introduction # <img src="https://github.githubassets.com/images/icons/emoji/unicode/2b50.png" width="30"></img> Introduction
Waybackpy is a [Python package](https://www.udacity.com/blog/2021/01/what-is-a-python-package.html) and a [CLI](https://www.w3schools.com/whatis/whatis_cli.asp) tool that interfaces with the [Wayback Machine](https://en.wikipedia.org/wiki/Wayback_Machine) API. Waybackpy is a Python package and a CLI tool that interfaces with the Wayback Machine APIs.
Wayback Machine has 3 client side [API](https://www.redhat.com/en/topics/api/what-are-application-programming-interfaces)s. Wayback Machine has 3 client side APIs.
- [Save API](https://github.com/akamhy/waybackpy/wiki/Wayback-Machine-APIs#save-api) - SavePageNow or Save API
- [Availability API](https://github.com/akamhy/waybackpy/wiki/Wayback-Machine-APIs#availability-api) - CDX Server API
- [CDX API](https://github.com/akamhy/waybackpy/wiki/Wayback-Machine-APIs#cdx-api) - Availability API
These three APIs can be accessed via the waybackpy either by importing it in a script or from the CLI. These three APIs can be accessed via the waybackpy either by importing it from a python file/module or from the command-line interface.
## <img src="https://github.githubassets.com/images/icons/emoji/unicode/1f3d7.png" width="20"></img> Installation ## <img src="https://github.githubassets.com/images/icons/emoji/unicode/1f3d7.png" width="20"></img> Installation
@@ -165,7 +165,8 @@ https://web.archive.org/web/20171206002737/http://pypi.org:80/
#### Availability API #### Availability API
It is recommended to not use the availability API due to performance issues. All the methods of availability API interface class, `WaybackMachineAvailabilityAPI`, are also implemented in the CDX server API interface class, `WaybackMachineCDXServerAPI`. It is recommended to not use the availability API due to performance issues. All the methods of availability API interface class, `WaybackMachineAvailabilityAPI`, are also implemented in the CDX server API interface class, `WaybackMachineCDXServerAPI`. Also note
that the `newest()` method of `WaybackMachineAvailabilityAPI` can be more recent than `WaybackMachineCDXServerAPI`'s same method.
```python ```python
>>> from waybackpy import WaybackMachineAvailabilityAPI >>> from waybackpy import WaybackMachineAvailabilityAPI