zim.www

module documentation

(source)

This module contains a web interface for zim. This is an alternative to the GUI application.

It can be run either as a stand-alone web server or embedded in another server as a cgi-bin script or using one of the python web frameworks using the "WSGI" API.

The main classes here are WWWInterface which implements the interface (and is callable as a "WSGI" application) and Server which implements the standalone server.

Class	`WebPageNotFoundError`	Error whan a page is not found (404)
Class	`WebPathNotValidError`	Error when the url points to an invalid page path
Class	`WWWError`	Error with http error code
Class	`WWWInterface`	Class to handle the WWW interface for zim notebooks.
Class	`WWWLinker`	Implements a linker that returns the correct links for the way the server handles URLs.
Function	`main`	Undocumented
Function	`make_server`	No summary
Variable	`logger`	Undocumented

def main(notebook, port=8080, public=True, **opts): (source)

Undocumented

def make_server(notebook, port=8080, public=True, auth_creds=None, **opts): (source)

Create a simple http server

Parameters
notebook	the notebook location
port	the http port to serve on
public	allow connections to the server from other computers - if `False` can only connect from localhost
auth_creds	credentials for HTTP-authentication
**opts	options for `WWWInterface.__init__()`
Returns
a `WSGIServer` object

logger = (source)

Undocumented