From 5407681c34ac299ad5c0622ea0c2d186a330fec1 Mon Sep 17 00:00:00 2001 From: Akash Mahanty Date: Tue, 15 Mar 2022 20:33:51 +0530 Subject: [PATCH] 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 --- CITATION.cff | 4 ++-- README.md | 26 +++++++++++--------------- waybackpy/__init__.py | 2 +- 3 files changed, 14 insertions(+), 18 deletions(-) diff --git a/CITATION.cff b/CITATION.cff index bbec6c8..87725ee 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -2,9 +2,9 @@ cff-version: 1.2.0 message: "If you use this software, please cite it as below." title: waybackpy 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 -date-released: 2021-02-22 +date-released: 2022-03-15 type: software authors: - given-names: Akash diff --git a/README.md b/README.md index b60a541..d23f21c 100644 --- a/README.md +++ b/README.md @@ -22,15 +22,15 @@ # 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) -- [Availability API](https://github.com/akamhy/waybackpy/wiki/Wayback-Machine-APIs#availability-api) -- [CDX API](https://github.com/akamhy/waybackpy/wiki/Wayback-Machine-APIs#cdx-api) +- SavePageNow or Save API +- CDX Server 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. ## Installation @@ -58,11 +58,11 @@ pip install git+https://github.com/akamhy/waybackpy.git ## Docker Image -Docker Hub : +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 (), an Italian cybersecurity startup. +RAUDI is a tool by [SecSI](https://secsi.io), an Italian cybersecurity startup. ## Usage @@ -165,7 +165,8 @@ https://web.archive.org/web/20171206002737/http://pypi.org:80/ #### 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 >>> 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 . -## 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. diff --git a/waybackpy/__init__.py b/waybackpy/__init__.py index 08ead46..2119ec4 100644 --- a/waybackpy/__init__.py +++ b/waybackpy/__init__.py @@ -1,6 +1,6 @@ """Module initializer and provider of static information.""" -__version__ = "3.0.5" +__version__ = "3.0.6" from .availability_api import WaybackMachineAvailabilityAPI from .cdx_api import WaybackMachineCDXServerAPI