1
0
mirror of https://github.com/webrecorder/pywb.git synced 2025-03-15 16:14:48 +01:00
pywb/README.rst

79 lines
3.1 KiB
ReStructuredText
Raw Normal View History

Webrecorder pywb 2.4
====================
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
: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
:target: https://codecov.io/gh/webrecorder/pywb
Web Archiving Tools for All
---------------------------
2014-03-10 19:01:20 -07:00
`View the full pywb documentation <https://pywb.readthedocs.org>`_
2015-03-17 01:06:06 -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
^^^^^^^^^^^^
2019-07-09 19:37:03 -07:00
The 2.x release included a major overhaul of pywb and introduces many new features, including the following:
* 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.
* Support for Memento API aggregation and fallback chains for querying multiple remote and local archival sources.
* HTTP/S Proxy Mode with customizable certificate authority for proxy mode recording and replay.
* Flexible rewriting system with pluggable rewriters for different content-types.
2019-07-09 19:37:03 -07:00
* Standalone, modular `client-side rewriting system (wombat.js) <https://github.com/webrecorder/wombat>`_ to handle most modern web sites.
* Improved 'calendar' query UI with incremental loading, grouping results by year and month, and updated replay banner.
* New in 2.4: Extensible UI customizations system for modifying all aspects of the UI.
* New in 2.4: Robust access control system for blocking or excluding URLs, by prefix or by exact match.
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
* Install with ``python setup.py install``
* Run tests with ``python setup.py test``
2014-05-30 10:29:22 -07:00
* Run Wayback with ``wayback`` (see docs for info on how to setup collections)
2014-05-30 10:29:22 -07:00
* Build docs locally with: ``cd docs; make html``. (The docs will be built in ``./_build/html/index.html``)
Consult the local or `online docs <https://pywb.readthedocs.org>`_ for latest usage and configuration details.
2014-10-19 08:32:11 -07:00
Contributions & Bug Reports
---------------------------
2014-10-19 08:32:11 -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
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