Python API to web-monitoring-db

This is a Python interface to the web-monitoring-db REST API. Authentication information is required.

Tutorial

TO DO

API Documentation

Client(email, password[, url, timeout, retries])	Communicate with web-monitoring-db via its REST API.
Client.from_env(**kwargs)	Instantiate a Client by obtaining its authentication info from these environment variables:
Client.get_pages(*[, chunk, chunk_size, …])	Get an iterable of all pages, optionally filtered by search criteria.
Client.get_page(page_id)	Lookup a specific Page by ID.
Client.get_versions(*[, page_id, chunk, …])	Iterate over a set of versions, optionally filtered by search criteria.
Client.get_version(version_id[, …])	Lookup a specific Version by ID.
Client.add_version(*, page_id, capture_time, …)	Submit one new Version.
Client.add_versions(versions, *[, update, …])	Submit versions in bulk for importing into web-monitoring-db.
Client.get_changes(page_id[, include_total])	Iterate through a set of changes between any two versions of a page.
Client.get_change(*, page_id, to_version_id)	Get a Changes between two Versions.
Client.get_annotations(*, page_id, to_version_id)	Iterate through Annotations for a Change between two Versions.
Client.get_annotation(*, annotation_id, …)	Get a specific Annontation.
Client.add_annotation(*, annotation, …[, …])	Submit updated annotations for a change between versions.