backup/pywb
1
0
Fork 0
mirror of https://github.com/webrecorder/pywb.git synced 2025-03-24 06:59:52 +01:00
Code Issues Projects Releases Activity

tweak README, add no cover pragmas to blocking cli apps (for now)

Browse Source
This commit is contained in:
Ilya Kreymer 2014-04-02 21:43:09 -07:00
parent 80f2da9548
commit 1e7ecb901a
3 changed files with 16 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.rst
View File

@ -9,8 +9,12 @@ PyWb 0.2.2
pywb is a python implementation of web archival replay tools, sometimes also known as 'Wayback Machine'. pywb is a python implementation of web archival replay tools, sometimes also known as 'Wayback Machine'.
The software includes wsgi apps and other tools which 'replay' archived web data pywb allows high-fidelity replay (browsing) of archived web data stored in standardized `ARC <http://en.wikipedia.org/wiki/ARC_(file_format)>`_ and `WARC <http://en.wikipedia.org/wiki/Web_ARChive>`_.
stored in standard `ARC <http://en.wikipedia.org/wiki/ARC_(file_format)>`_ and `WARC <http://en.wikipedia.org/wiki/Web_ARChive>`_ files and can provide additional information about the archived captures.
Latest Changes
""""""""""""""
See `CHANGES.rst <https://github.com/ikreymer/pywb/blob/develop/CHANGES.rst>`_ for up-to-date changelist.
Quick Install & Run Samples Quick Install & Run Samples
@ -32,8 +36,11 @@ installation and testing examples.)
Configure to Replay Archived Content Configure to Replay Archived Content
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you have existing WARC or ARC files (.warc, .warc.gz, .arc, .arc.gz), you should be able If you have existing WARC or ARC files (.warc, .warc.gz, .arc, .arc.gz), you should be able to view
to replay them in pywb after creating sorted indexs with the ``cdx-indexer`` script. their contents in pywb after creating sorted .cdx index files of their contents.
This process can be done by running the ``cdx-indexer`` script and only needs to be done once.
(See the note below if you already have .cdx files for your archives)
Given an archive of warcs at ``myarchive/warcs`` Given an archive of warcs at ``myarchive/warcs``
@ -63,6 +70,9 @@ Given an archive of warcs at ``myarchive/warcs``
(You can also ./run-uwsgi.sh for running with those WSGI containers) (You can also ./run-uwsgi.sh for running with those WSGI containers)
See `INSTALL.rst <https://github.com/ikreymer/pywb/blob/develop/INSTALL.rst>`_ for additional installation info.
Use existing .cdx index files Use existing .cdx index files
""""""""""""""""""""""""""""" """""""""""""""""""""""""""""
@ -79,13 +89,6 @@ If you would like to use non-SURT ordered .cdx files, simply add this field to t
surt_ordered: false surt_ordered: false
Latest Changes
~~~~~~~~~~~~~~
See `CHANGES.rst <https://github.com/ikreymer/pywb/develop/CHANGES.rst>`_ for up-to-date changelist.
About Wayback About Wayback
~~~~~~~~~~~~~ ~~~~~~~~~~~~~

2
pywb/apps/cdx_server.py
View File

@ -11,7 +11,7 @@ application = init_app(create_cdx_server_app,
load_yaml=True) load_yaml=True)
def main(): def main(): # pragma: no cover
start_wsgi_server(application, 'CDX Server', default_port=8090) start_wsgi_server(application, 'CDX Server', default_port=8090)
if __name__ == "__main__": if __name__ == "__main__":

2
pywb/apps/wayback.py
View File

@ -7,7 +7,7 @@ from pywb.core.pywb_init import create_wb_router
application = init_app(create_wb_router, load_yaml=True) application = init_app(create_wb_router, load_yaml=True)
def main(): def main(): # pragma: no cover
start_wsgi_server(application, 'Wayback') start_wsgi_server(application, 'Wayback')
if __name__ == "__main__": if __name__ == "__main__":