pywb/docs/code/pywb.utils.rst

pywb.utils package
==================

Submodules
----------

pywb.utils.binsearch module
---------------------------

.. automodule:: pywb.utils.binsearch
   :members:
   :undoc-members:
   :show-inheritance:

pywb.utils.canonicalize module
------------------------------

.. automodule:: pywb.utils.canonicalize
   :members:
   :undoc-members:
   :show-inheritance:

pywb.utils.format module
------------------------

.. automodule:: pywb.utils.format
   :members:
   :undoc-members:
   :show-inheritance:

pywb.utils.geventserver module
------------------------------

.. automodule:: pywb.utils.geventserver
   :members:
   :undoc-members:
   :show-inheritance:

pywb.utils.io module
--------------------

.. automodule:: pywb.utils.io
   :members:
   :undoc-members:
   :show-inheritance:

pywb.utils.loaders module
-------------------------

.. automodule:: pywb.utils.loaders
   :members:
   :undoc-members:
   :show-inheritance:

pywb.utils.memento module
-------------------------

.. automodule:: pywb.utils.memento
   :members:
   :undoc-members:
   :show-inheritance:

pywb.utils.merge module
-----------------------

.. automodule:: pywb.utils.merge
   :members:
   :undoc-members:
   :show-inheritance:

pywb.utils.wbexception module
-----------------------------

.. automodule:: pywb.utils.wbexception
   :members:
   :undoc-members:
   :show-inheritance:

Module contents
---------------

.. automodule:: pywb.utils
   :members:
   :undoc-members:
   :show-inheritance:
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`pywb.utils package`
			`==================`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
			`Submodules`
			`----------`

docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`pywb.utils.binsearch module`
			`---------------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
			`.. automodule:: pywb.utils.binsearch`
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`pywb.utils.canonicalize module`
			`------------------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`.. automodule:: pywb.utils.canonicalize`
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`pywb.utils.format module`
			`------------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`.. automodule:: pywb.utils.format`
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`pywb.utils.geventserver module`
			`------------------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`.. automodule:: pywb.utils.geventserver`
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`pywb.utils.io module`
			`--------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`.. automodule:: pywb.utils.io`
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`pywb.utils.loaders module`
			`-------------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`.. automodule:: pywb.utils.loaders`
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`pywb.utils.memento module`
			`-------------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
New Documentation (#252) * docs work: - remove old doc folder - generate new sphinx docs rewrite: fix existing docstrings for rst add 'make apidoc' to rerun apidoc on pywb root apidocs in docs/code first pass on usage manual in docs/manual * use default theme * docs config work: - remove modules.rst, use pywb toc directly - make apidoc force rebuild - comment out alabaster theme config * Update usage.rst with working dir info * docs: add configuring web archive page, ui customizations, custom collections explanations * work on 'custom collections' section * docs: update dir tree, switch recording/proxy order * docs: improve framed vs frameless intro add 'custom outer replay frame' section 2017-10-04 22:02:03 -07:00			`.. automodule:: pywb.utils.memento`
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`pywb.utils.merge module`
			`-----------------------`
Docs, custom metadata improvements (#509) * metadata/coll_config: don't confuse user metadata with collection config, don't display collection config settings as metadata (ukwa/ukwa-pywb#47) - for collection template, add separate 'coll_config' dict, keep user metadata only in 'metadata' dict (default to empty) - for static collections, assume metadata is in the 'metadata' dict of collection config - for dynamic collections, load metadata.yaml into 'metadata' dict - ensure 'metadata' key is passed to frame_insert - ensure 'metadata' added consistently in framed and non-framed mode - tests: update tests to ensure metadata is added consistently - fuzzymatch: don't match 204 OPTIONS responses, update fuzzymatcher test * documentation - add documentation for metadata in ui-customization, rebuild docs, - add link to ui customization from configuring - work on access control docs * fixed small typo's in ui-customization.rst * frontendapp: fix doc string - misc: remove warning on urllib3 Retry init - set version to pywb 2.4.0rc0 Co-Authored-By: John Berlin <n0tan3rd@gmail.com> 2019-10-27 01:39:52 +01:00
			`.. automodule:: pywb.utils.merge`
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`
Docs, custom metadata improvements (#509) * metadata/coll_config: don't confuse user metadata with collection config, don't display collection config settings as metadata (ukwa/ukwa-pywb#47) - for collection template, add separate 'coll_config' dict, keep user metadata only in 'metadata' dict (default to empty) - for static collections, assume metadata is in the 'metadata' dict of collection config - for dynamic collections, load metadata.yaml into 'metadata' dict - ensure 'metadata' key is passed to frame_insert - ensure 'metadata' added consistently in framed and non-framed mode - tests: update tests to ensure metadata is added consistently - fuzzymatch: don't match 204 OPTIONS responses, update fuzzymatcher test * documentation - add documentation for metadata in ui-customization, rebuild docs, - add link to ui customization from configuring - work on access control docs * fixed small typo's in ui-customization.rst * frontendapp: fix doc string - misc: remove warning on urllib3 Retry init - set version to pywb 2.4.0rc0 Co-Authored-By: John Berlin <n0tan3rd@gmail.com> 2019-10-27 01:39:52 +01:00
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`pywb.utils.wbexception module`
			`-----------------------------`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
			`.. automodule:: pywb.utils.wbexception`
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`
add API doc for all packages with sphinx-apidoc 2014-03-07 20:09:33 +00:00
			`Module contents`
			`---------------`

			`.. automodule:: pywb.utils`
docs: add new UI docs: - add ui-overview as UI toc page - refactor ui-customization to top-level customizations page - add template-guide for in-depth template reference - add new-vue-ui page for docs on new ui, with images - fix adding logo to old ui, add to docs 2021-12-13 22:54:29 -08:00			`:members:`
			`:undoc-members:`
			`:show-inheritance:`