Fork of https://github.com/akamhy/waybackpy Wayback Machine API interface & a command-line tool

archive-webpage archive-webpages cdx-api internet-archive internet-archiving osint savepagenow wayback-machine wayback-machine-api wayback-machine-python web-archiving webarchiving

Go to file

Akash Mahanty 5954fcc646 format with black		2022-02-09 15:51:11 +05:30
.github	Add tests (#149 )	2022-02-08 17:46:59 +05:30
assets	upload logo and make p path not text	2022-01-21 21:11:42 +05:30
tests	apply isort	2022-02-09 11:20:59 +05:30
waybackpy	format with black	2022-02-09 15:51:11 +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
.pep8speaks.yml	Improve pylint score (#142 )	2022-02-08 06:42:20 +09:00
.whitesource	fix: format md and yml (#129 )	2022-02-04 22:31:46 +05:30
CODE_OF_CONDUCT.md	fix: format md and yml (#129 )	2022-02-04 22:31:46 +05:30
CONTRIBUTORS.md	+ jfinkhaeuser and rafael (#150 )	2022-02-08 20:34:34 +05:30
LICENSE	date year range 2020-2022	2022-01-21 11:55:42 +05:30
pyproject.toml	Format and lint codes and fix packaging (#125 )	2022-02-03 19:13:39 +05:30
README.md	+ codecov badge	2022-02-08 17:49:05 +05:30
requirements-dev.txt	Typing (#128 )	2022-02-05 03:23:36 +09:00
requirements.txt	Typing (#128 )	2022-02-05 03:23:36 +09:00
setup.cfg	added trove Typing :: Typed and Development Status :: 5 - Production/Stable	2022-02-09 15:47:38 +05:30
setup.py	Format and lint codes and fix packaging (#125 )	2022-02-03 19:13:39 +05:30
snapcraft.yaml	fix: format md and yml (#129 )	2022-02-04 22:31:46 +05:30

README.md

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

Introduction

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

Wayback Machine has 3 client side APIs.

These three APIs can be accessed via the waybackpy either by importing it in a script or from the CLI.

Installation

Using pip, from PyPI (recommended):

pip install waybackpy

Using conda, from conda-forge (recommended):

See also waybackpy feedstock, maintainers are @rafaelrdealmeida, @labriunesp and @akamhy.

conda install -c conda-forge waybackpy

Install directly from this git repository (NOT recommended):

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 is at https://github.com/akamhy/waybackpy/wiki/Python-package-docs.

As a CLI tool

Demo video on asciinema.org, you can copy the text from video:

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

License

Released under the MIT License. See license for details.