Benjamin_Loison/waybackpy
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
Fork of https://github.com/akamhy/waybackpy Wayback Machine API interface & a command-line tool
381 Commits 1 Branch 37 Tags 1.1 MiB
Python 100%
df64e839d7
Go to file
Akash Mahanty df64e839d7 added trove classifiers for python 3.10
2022-01-22 00:57:10 +05:30
.github/workflows Create codeql-analysis.yml 2022-01-21 11:12:59 +05:30
assets upload logo and make p path not text 2022-01-21 21:11:42 +05:30
waybackpy waybackpy/save_api.py : Added doc strings and also lint with black. 2022-01-22 00:41:10 +05:30
_config.yml now using requests lib as it handles errors nicely 2020-12-13 15:05:57 +05:30
.gitignore removed JSON from init, this was resulting in too much unnecessary taffic. Some users who are thousands of URLs were blocked by IA (#53) 2021-01-01 16:38:57 +05:30
.whitesource Add .whitesource configuration file 2022-01-02 08:45:07 +00:00
CONTRIBUTORS.md _get_response is not used anymore 2022-01-21 19:43:35 +05:30
LICENSE date year range 2020-2022 2022-01-21 11:55:42 +05:30
README.md Update README.md 2022-01-21 09:54:04 +05:30
requirements.txt Create separate module for the 3 different APIs also CDX is now CLI supported. 2022-01-02 14:14:45 +05:30
setup.cfg Code style improvements (#20) 2020-07-22 10:09:14 +05:30
setup.py added trove classifiers for python 3.10 2022-01-22 00:57:10 +05:30

README.md


Python package & CLI tool that interfaces with the Wayback Machine API

pypi Contributions Welcome Downloads GitHub lastest commit PyPI - Python Version

⭐️ Introduction

Waybackpy is a Python package and a CLI tool that interfaces with the Wayback Machine API.

Wayback Machine has 3 client side APIs.

  • Save API
  • Availability API
  • CDX API

All three of these can be accessed by waybackpy.

🏗 Installation

Using pip:

pip install waybackpy

Install directly from GitHub:

pip install git+https://github.com/akamhy/waybackpy.git

🐳 Docker Image

Docker Hub : https://hub.docker.com/r/secsi/waybackpy

Docker image is automatically updated on every release by Regulary and Automatically Updated Docker Images (RAUDI).

RAUDI is a tool by SecSI (https://secsi.io), an Italian cybersecurity startup.

🚀 Usage

As a Python package

Save API aka SavePageNow
>>> from waybackpy import WaybackMachineSaveAPI
>>> url = "https://github.com"
>>> user_agent = "Mozilla/5.0 (Windows NT 5.1; rv:40.0) Gecko/20100101 Firefox/40.0"
>>> 
>>> save_api = WaybackMachineSaveAPI(url, user_agent)
>>> save_api.save()
https://web.archive.org/web/20220118125249/https://github.com/
>>> save_api.cached_save
False
>>> save_api.timestamp()
datetime.datetime(2022, 1, 18, 12, 52, 49)
Availability API
>>> from waybackpy import WaybackMachineAvailabilityAPI
>>> 
>>> url = "https://google.com"
>>> user_agent = "Mozilla/5.0 (Windows NT 5.1; rv:40.0) Gecko/20100101 Firefox/40.0"
>>> 
>>> availability_api = WaybackMachineAvailabilityAPI(url, user_agent)
>>> 
>>> availability_api.oldest()
https://web.archive.org/web/19981111184551/http://google.com:80/
>>> 
>>> availability_api.newest()
https://web.archive.org/web/20220118150444/https://www.google.com/
>>> 
>>> availability_api.near(year=2010, month=10, day=10, hour=10)
https://web.archive.org/web/20101010101708/http://www.google.com/
CDX API aka CDXServerAPI
>>> from waybackpy import WaybackMachineCDXServerAPI
>>> url = "https://pypi.org"
>>> user_agent = "Mozilla/5.0 (Windows NT 5.1; rv:40.0) Gecko/20100101 Firefox/40.0"
>>> cdx = WaybackMachineCDXServerAPI(url, user_agent, start_timestamp=2016, end_timestamp=2017)
>>> for item in cdx.snapshots():
...     print(item.archive_url)
... 
https://web.archive.org/web/20160110011047/http://pypi.org/
https://web.archive.org/web/20160305104847/http://pypi.org/
.
. # URLS REDACTED FOR READABILITY
.
https://web.archive.org/web/20171127171549/https://pypi.org/
https://web.archive.org/web/20171206002737/http://pypi.org:80/

Documentation at https://github.com/akamhy/waybackpy/wiki/Python-package-docs.

As a CLI tool

$ waybackpy --save --url "https://en.wikipedia.org/wiki/Social_media" --user_agent "my-unique-user-agent"
https://web.archive.org/web/20200719062108/https://en.wikipedia.org/wiki/Social_media

$ waybackpy --oldest --url "https://en.wikipedia.org/wiki/Humanoid" --user_agent "my-unique-user-agent"
https://web.archive.org/web/20040415020811/http://en.wikipedia.org:80/wiki/Humanoid

$ waybackpy --url google.com --user_agent "my-unique-user-agent" --near --year 2008 --month 8 --day 8
Archive URL:
https://web.archive.org/web/20080808014003/http://www.google.com:80/

CLI documentation is at https://github.com/akamhy/waybackpy/wiki/CLI-docs.

🛡 License

License: MIT

Released under the MIT License. See license for details.