2018-10-23 09:58:10 -07:00
Webrecorder pywb 2.1
2018-02-13 13:49:10 -08:00
====================
2014-03-10 19:01:20 -07:00
2018-01-29 18:30:54 -08:00
.. image :: https://travis-ci.org/webrecorder/pywb.svg?branch=master
2018-01-17 09:59:51 -08:00
:target: https://travis-ci.org/webrecorder/pywb
2018-01-29 18:30:54 -08:00
.. image :: https://ci.appveyor.com/api/projects/status/qxnbunw65o929599/branch/master?svg=true
:target: https://ci.appveyor.com/project/webrecorder/pywb/branch/master
.. image :: https://codecov.io/gh/webrecorder/pywb/branch/master/graph/badge.svg
2018-01-17 09:59:51 -08:00
:target: https://codecov.io/gh/webrecorder/pywb
2014-11-04 22:11:25 -08:00
2017-10-18 10:12:44 -07:00
Web Archiving Tools for All
---------------------------
2014-03-10 19:01:20 -07:00
2018-10-23 09:58:10 -07:00
`View the full pywb documentation <https://pywb.readthedocs.org> `_
2015-03-17 01:06:06 -07:00
2017-10-18 10:12:44 -07:00
**pywb** is a Python (2 and 3) web archiving toolkit for replaying web archives large and small as accurately as possible.
The toolkit now also includes new features for creating high-fidelity web archives.
This toolset forms the foundation of Webrecorder project, but also provides a generic web archiving toolkit
that is used by other web archives, including the traditional "Wayback Machine" functionality.
New Features
^^^^^^^^^^^^
2018-10-23 09:58:10 -07:00
The 2.0 release included a major overhaul of pywb and introduces many new features, including the following:
2017-10-18 10:12:44 -07:00
* Dynamic multi-collection configuration system with no-restart updates.
* New recording capability to create new web archives from the live web or other archives.
* Componentized architecture with standalone Warcserver, Recorder and Rewriter components.
2018-01-30 07:49:54 -08:00
* Support for Memento API aggregation and fallback chains for querying multiple remote and local archival sources.
2017-10-18 10:12:44 -07:00
2018-01-30 07:49:54 -08:00
* HTTP/S Proxy Mode with customizable certificate authority for proxy mode recording and replay.
2017-10-18 10:12:44 -07:00
* Flexible rewriting system with pluggable rewriters for different content-types.
* Significantly improved client-side rewriting to handle most modern web sites.
2018-02-10 11:48:50 -08:00
* Improved 'calendar' query UI, grouping results by year and month, and updated replay banner.
2018-01-11 21:34:04 -08:00
2017-10-18 10:12:44 -07:00
Please see the `full documentation <https://pywb.readthedocs.org> `_ for more detailed info on all these features.
Installation
------------
To run and install locally you can:
2014-05-30 10:29:22 -07:00
2017-10-15 22:47:23 -07:00
* Install with `` python setup.py install ``
2015-03-25 12:06:05 -07:00
2017-10-15 22:47:23 -07:00
* Run tests with `` python setup.py test ``
2014-05-30 10:29:22 -07:00
2017-10-15 22:47:23 -07:00
* Run Wayback with `` wayback `` (see docs for info on how to setup collections)
2014-05-30 10:29:22 -07:00
2018-01-11 21:34:04 -08:00
* Build docs locally with: `` cd docs; make html `` . (The docs will be built in `` ./_build/html/index.html `` )
2017-10-18 10:12:44 -07:00
Consult the local or `online docs <https://pywb.readthedocs.org> `_ for latest usage and configuration details.
2016-03-10 12:51:14 -08:00
2014-10-19 08:32:11 -07:00
2017-10-18 10:12:44 -07:00
Contributions & Bug Reports
---------------------------
2014-10-19 08:32:11 -07:00
2017-10-18 10:12:44 -07:00
Users are encouraged to fork and contribute to this project to keep improving web archiving tools.
2014-10-19 08:32:11 -07:00
2018-01-30 07:49:54 -08:00
A few key features are high on list of priorities, but have not yet been implemented, including:
* Url Exclusion System
* UI Improvements
If you are interested in contributing, especially to any of these areas, please let us know!
Otherwise, please take a look at `list of current issues <https://github.com/webrecorder/pywb/issues> `_ and feel free to open new ones about any aspect of pywb, including the new documentation.
2014-10-18 17:00:33 -07:00