v3.0.6 (#170)
* remove the license section from readme This does not mean that I'm waving the copyrights rather just formatting the README * remove useless external links form the README lead and also added a line about the recentness of the newest method between the availability and CDX server API. * incr version to 3.0.6 and change date to todays da -te that is 15th of March, 2022. * update secsi and DI section * v3.0.5 --> v3.0.6
This commit is contained in:
parent
cfd977135d
commit
5407681c34
@ -2,9 +2,9 @@ cff-version: 1.2.0
|
|||||||
message: "If you use this software, please cite it as below."
|
message: "If you use this software, please cite it as below."
|
||||||
title: waybackpy
|
title: waybackpy
|
||||||
abstract: "Python package that interfaces with the Internet Archive's Wayback Machine APIs. Archive pages and retrieve archived pages easily."
|
abstract: "Python package that interfaces with the Internet Archive's Wayback Machine APIs. Archive pages and retrieve archived pages easily."
|
||||||
version: '3.0.5'
|
version: '3.0.6'
|
||||||
doi: 10.5281/ZENODO.3977276
|
doi: 10.5281/ZENODO.3977276
|
||||||
date-released: 2021-02-22
|
date-released: 2022-03-15
|
||||||
type: software
|
type: software
|
||||||
authors:
|
authors:
|
||||||
- given-names: Akash
|
- given-names: Akash
|
||||||
|
26
README.md
26
README.md
@ -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
|
||||||
|
|
||||||
@ -58,11 +58,11 @@ pip install git+https://github.com/akamhy/waybackpy.git
|
|||||||
|
|
||||||
## <img src="https://github.githubassets.com/images/icons/emoji/unicode/1f433.png" width="20"></img> Docker Image
|
## <img src="https://github.githubassets.com/images/icons/emoji/unicode/1f433.png" width="20"></img> Docker Image
|
||||||
|
|
||||||
Docker Hub : <https://hub.docker.com/r/secsi/waybackpy>
|
Docker Hub: [hub.docker.com/r/secsi/waybackpy](https://hub.docker.com/r/secsi/waybackpy)
|
||||||
|
|
||||||
[Docker image](https://searchitoperations.techtarget.com/definition/Docker-image) is automatically updated on every release by [Regulary and Automatically Updated Docker Images](https://github.com/cybersecsi/RAUDI) (RAUDI).
|
Docker image is automatically updated on every release by [Regulary and Automatically Updated Docker Images](https://github.com/cybersecsi/RAUDI) (RAUDI).
|
||||||
|
|
||||||
RAUDI is a tool by SecSI (<https://secsi.io>), an Italian cybersecurity startup.
|
RAUDI is a tool by [SecSI](https://secsi.io), an Italian cybersecurity startup.
|
||||||
|
|
||||||
## <img src="https://github.githubassets.com/images/icons/emoji/unicode/1f680.png" width="20"></img> Usage
|
## <img src="https://github.githubassets.com/images/icons/emoji/unicode/1f680.png" width="20"></img> Usage
|
||||||
|
|
||||||
@ -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
|
||||||
@ -201,10 +202,5 @@ Demo video on [asciinema.org](https://asciinema.org/a/469890), you can copy the
|
|||||||
|
|
||||||
> CLI documentation is at <https://github.com/akamhy/waybackpy/wiki/CLI-docs>.
|
> CLI documentation is at <https://github.com/akamhy/waybackpy/wiki/CLI-docs>.
|
||||||
|
|
||||||
## <img src="https://github.githubassets.com/images/icons/emoji/unicode/1f6e1.png" width="20"></img> License
|
|
||||||
|
|
||||||
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/akamhy/waybackpy/blob/master/LICENSE)
|
|
||||||
|
|
||||||
Copyright (c) 2020-2022 Akash Mahanty Et al.
|
|
||||||
|
|
||||||
Released under the MIT License. See [license](https://github.com/akamhy/waybackpy/blob/master/LICENSE) for details.
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
"""Module initializer and provider of static information."""
|
"""Module initializer and provider of static information."""
|
||||||
|
|
||||||
__version__ = "3.0.5"
|
__version__ = "3.0.6"
|
||||||
|
|
||||||
from .availability_api import WaybackMachineAvailabilityAPI
|
from .availability_api import WaybackMachineAvailabilityAPI
|
||||||
from .cdx_api import WaybackMachineCDXServerAPI
|
from .cdx_api import WaybackMachineCDXServerAPI
|
||||||
|
Loading…
Reference in New Issue
Block a user