handler Package

handler Package

Convenience routines for presenting the root of the web server. There are probably better places for this.

tiddlyweb.web.handler.root(environ, start_response)

Convenience method to provide an entry point at root.

bag Module

Methods for accessing Bag entities, GET the tiddlers in the bag, list the available bags, PUT a Bag as a JSON object.

These need some refactoring.

tiddlyweb.web.handler.bag.delete(environ, start_response)

Remove a bag and its tiddlers from the store. How the store chooses to handle remove and what it means is up to the store.

tiddlyweb.web.handler.bag.get(environ, start_response)

Get a representation in some serialization of a bag (the bag itself not the tiddlers within).

tiddlyweb.web.handler.bag.get_tiddlers(environ, start_response)

Get a list representation of the tiddlers in a bag. The information sent is dependent on the serialization chosen.

tiddlyweb.web.handler.bag.list_bags(environ, start_response)

List all the bags that the current user can read.

tiddlyweb.web.handler.bag.put(environ, start_response)

Put a bag to the server, meaning the description and policy of the bag, if policy allows.

chronicle Module

A chronicle is a stack of tiddlers, usually revisions of one tiddler. By POSTing a chronicle of tiddlers originally named A to tiddler B, we can effectively rename a tiddler while preserving history.

tiddlyweb.web.handler.chronicle.post_revisions(environ, start_response)

Take a collection of JSON tiddlers, each with a text key and value, and process them into the store. That collection is known as a TiddlerChronicle.

recipe Module

Access to Recipe objects via the web. List recipes, GET a recipe, PUT a recipe, GET the tiddlers produced by a recipe.

tiddlyweb.web.handler.recipe.delete(environ, start_response)

Delete a recipe, where what delete means depends on the store used.

tiddlyweb.web.handler.recipe.get(environ, start_response)

Get the representation of a recipe, based on the requested serialization. Will usually show the list of bags and filters that make up the recipe.

tiddlyweb.web.handler.recipe.get_tiddlers(environ, start_response)

Get the list of tiddlers produced by this recipe.

tiddlyweb.web.handler.recipe.list_recipes(environ, start_response)

Get a list of all recipes the current user can read.

tiddlyweb.web.handler.recipe.put(environ, start_response)

Put a new recipe to the server.

search Module

Make a query into the store to find some tiddlers and list them in the interface.

tiddlyweb.web.handler.search.get(environ, start_response)

Perform a search on the store. What search means and what results are returned is dependent on the search implementation (if any) in the chosen store.

tiddlyweb.web.handler.search.get_search_query(environ)

Inspect tiddlyweb.query in the environment to get the search query.

tiddlyweb.web.handler.search.get_tiddlers(environ)

Call search in the store with search query to get the generator of tiddlers matching the query.

tiddler Module

Access to Tiddlers via the web. GET and PUT a Tiddler, GET a list of revisions of a Tiddler.

tiddlyweb.web.handler.tiddler.delete(environ, start_response)

Delete this tiddler from the store. What delete means is up to the store.

tiddlyweb.web.handler.tiddler.get(environ, start_response)

Get a representation of a single tiddler, dependent on the chosen serialization and permissions of the containing bag.

tiddlyweb.web.handler.tiddler.get_revisions(environ, start_response)

Get the list of revisions for this tiddler.

tiddlyweb.web.handler.tiddler.put(environ, start_response)

Put a tiddler into the store.

tiddlyweb.web.handler.tiddler.validate_tiddler_headers(environ, tiddler)

Check ETAG and last modified information to see if a) the client can use its cached tiddler b) we have edit contention when trying to write.

Table Of Contents

Previous topic

extractors Package

Next topic

wikitext Package

This Page