pywb/README.rst

Webrecorder pywb 2.0
====================

.. image:: https://travis-ci.org/ikreymer/pywb.svg?branch=master
      :target: https://travis-ci.org/ikreymer/pywb
.. image:: https://coveralls.io/repos/ikreymer/pywb/badge.svg?branch=master
      :target: https://coveralls.io/r/ikreymer/pywb?branch=master

**pywb** is a Python (2 and 3) web archive replay and recording toolkit.

This toolset forms the foundation of Webrecorder, but also provides a variety of web archiving tools,
such as the traditional "Wayback Machine" functionality.

Note: this version, which represents a major overhaul of pywb, is not yet released on pypi, but you can:

* Install with ``python setup.py install``

* Run tests with ``python setup.py test``

* Run Wayback with ``wayback`` (see docs for info on how to setup collections)

* Build docs locally with:  ``cd docs; make html``

* ..and a lot more!

Please see the `Webrecorder pywb documentation for usage and configuration info <https://pywb.readthedocs.org>`_
config and docs work: (#255) config and docs work: - autoindexing now set in config via 'autoindex: <secs>' option - autoindexing only runs in first uwsgi worker if in uwsgi - recorder config: rename props to 'rollover_' to match docs - docs: write configuring.rst section for recording mode, autoindexing and proxy mode! - update README for new pywb release, point to new docs! 2017-10-15 22:47:23 -07:00			`Webrecorder pywb 2.0`
			`====================`
add README.rst 2014-03-10 19:01:20 -07:00
update version to 0.9.5! 2015-04-17 12:30:21 -07:00			`.. image:: https://travis-ci.org/ikreymer/pywb.svg?branch=master`
Fixes for README.rst badges, tables finally working. 2014-03-12 17:50:47 -07:00			`:target: https://travis-ci.org/ikreymer/pywb`
update version to 0.9.5! 2015-04-17 12:30:21 -07:00			`.. image:: https://coveralls.io/repos/ikreymer/pywb/badge.svg?branch=master`
			`:target: https://coveralls.io/r/ikreymer/pywb?branch=master`
video work: live rewrite pings proxy with full rewrite, proxies direct range request reorg rangecache to support is_range() check, yt-specific logic (experimental) wombat: add date override (experimental) bump tentative version to 0.7.0! yt replays work with native player! (though still issues remain) 2014-11-04 22:11:25 -08:00
config and docs work: (#255) config and docs work: - autoindexing now set in config via 'autoindex: <secs>' option - autoindexing only runs in first uwsgi worker if in uwsgi - recorder config: rename props to 'rollover_' to match docs - docs: write configuring.rst section for recording mode, autoindexing and proxy mode! - update README for new pywb release, point to new docs! 2017-10-15 22:47:23 -07:00			`pywb is a Python (2 and 3) web archive replay and recording toolkit.`
add README.rst 2014-03-10 19:01:20 -07:00
config and docs work: (#255) config and docs work: - autoindexing now set in config via 'autoindex: <secs>' option - autoindexing only runs in first uwsgi worker if in uwsgi - recorder config: rename props to 'rollover_' to match docs - docs: write configuring.rst section for recording mode, autoindexing and proxy mode! - update README for new pywb release, point to new docs! 2017-10-15 22:47:23 -07:00			`This toolset forms the foundation of Webrecorder, but also provides a variety of web archiving tools,`
			`such as the traditional "Wayback Machine" functionality.`
readme tweaks and typo fixes 2015-03-17 01:06:06 -07:00
config and docs work: (#255) config and docs work: - autoindexing now set in config via 'autoindex: <secs>' option - autoindexing only runs in first uwsgi worker if in uwsgi - recorder config: rename props to 'rollover_' to match docs - docs: write configuring.rst section for recording mode, autoindexing and proxy mode! - update README for new pywb release, point to new docs! 2017-10-15 22:47:23 -07:00			`Note: this version, which represents a major overhaul of pywb, is not yet released on pypi, but you can:`
Update README.rst update for 0.4.0 2014-05-30 10:29:22 -07:00
config and docs work: (#255) config and docs work: - autoindexing now set in config via 'autoindex: <secs>' option - autoindexing only runs in first uwsgi worker if in uwsgi - recorder config: rename props to 'rollover_' to match docs - docs: write configuring.rst section for recording mode, autoindexing and proxy mode! - update README for new pywb release, point to new docs! 2017-10-15 22:47:23 -07:00			* Install with ``python setup.py install``
Update README to 0.9.1, add cdx api link, fix typo 2015-03-25 12:06:05 -07:00
config and docs work: (#255) config and docs work: - autoindexing now set in config via 'autoindex: <secs>' option - autoindexing only runs in first uwsgi worker if in uwsgi - recorder config: rename props to 'rollover_' to match docs - docs: write configuring.rst section for recording mode, autoindexing and proxy mode! - update README for new pywb release, point to new docs! 2017-10-15 22:47:23 -07:00			* Run tests with ``python setup.py test``
Update README.rst update for 0.4.0 2014-05-30 10:29:22 -07:00
config and docs work: (#255) config and docs work: - autoindexing now set in config via 'autoindex: <secs>' option - autoindexing only runs in first uwsgi worker if in uwsgi - recorder config: rename props to 'rollover_' to match docs - docs: write configuring.rst section for recording mode, autoindexing and proxy mode! - update README for new pywb release, point to new docs! 2017-10-15 22:47:23 -07:00			* Run Wayback with ``wayback`` (see docs for info on how to setup collections)
Update README.rst update for 0.4.0 2014-05-30 10:29:22 -07:00
config and docs work: (#255) config and docs work: - autoindexing now set in config via 'autoindex: <secs>' option - autoindexing only runs in first uwsgi worker if in uwsgi - recorder config: rename props to 'rollover_' to match docs - docs: write configuring.rst section for recording mode, autoindexing and proxy mode! - update README for new pywb release, point to new docs! 2017-10-15 22:47:23 -07:00			* Build docs locally with: ``cd docs; make html``
versions and readme: update version to 0.30.0, update README with python 2 and 3 support 2016-03-10 12:51:14 -08:00
config and docs work: (#255) config and docs work: - autoindexing now set in config via 'autoindex: <secs>' option - autoindexing only runs in first uwsgi worker if in uwsgi - recorder config: rename props to 'rollover_' to match docs - docs: write configuring.rst section for recording mode, autoindexing and proxy mode! - update README for new pywb release, point to new docs! 2017-10-15 22:47:23 -07:00			`* ..and a lot more!`
Update README with News! 2014-10-19 08:32:11 -07:00
config and docs work: (#255) config and docs work: - autoindexing now set in config via 'autoindex: <secs>' option - autoindexing only runs in first uwsgi worker if in uwsgi - recorder config: rename props to 'rollover_' to match docs - docs: write configuring.rst section for recording mode, autoindexing and proxy mode! - update README for new pywb release, point to new docs! 2017-10-15 22:47:23 -07:00			Please see the `Webrecorder pywb documentation for usage and configuration info <https://pywb.readthedocs.org>`_
Update README with News! 2014-10-19 08:32:11 -07:00

Add Gratipay link 2014-10-18 17:00:33 -07:00