Skip to content

A TiddlyWeb plugin to allow the dispatching of tiddlers to non-Python handlers by serialising tiddler data to JSON

License

Notifications You must be signed in to change notification settings

TiddlySpace/tiddlywebplugins.jsondispatcher

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About

A TiddlyWeb plugin to allow the dispatching of tiddlers to non-Python handlers by serialising tiddler data to JSON.

The primary purpose of this plugin is for use with websockets to deliver realtime tiddler updates via beanstalkd. For more explanation read this.

Requirements

  • Python
  • make
  • A working TiddlySpace instance to test against
  • py.test to run the tests

Contributing

setup.py is used to package up the plugin and install it.

Plugin code lives in the tiddlywebplugins directory.

Tests live in the test directory.

Usage

make test runs the tests. Currently there is just the one that ensures the plugin can be imported.

make install installs the plugin as a package on your system (you may need sudo for this.)

Configuration for TiddlySpace

Edit tiddlywebconfig.py to include the following config:

'use_dispatcher': True,
'beanstalk_listeners': ['tiddlywebplugins.jsondispatcher']

The plugin is registered as a beanstalk listener as that is where it receives incoming tiddler data from.

For more details on usage run:

pydoc tiddlywebplugins/jsondispatcher.py

Credits

@cdent is the original author of jsondispatcher.py. I've just packaged it up a bit.

See Also

See the tiddlyspace websockets node application that this plugin works with.

About

A TiddlyWeb plugin to allow the dispatching of tiddlers to non-Python handlers by serialising tiddler data to JSON

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages