TiddlyWeb Core
Python Other
Latest commit d9606c0 Oct 28, 2016 @cdent cdent Pin the html5lib requiremens so that sanitizers will work
The interface has changed in a very weird way and the versioning
of html5lib has also become very weird so the best immediate
solution is to use the version right before things changed until
there is further review.
Permalink
Failed to load latest commit information.
docs Replace tiddlyspace docs references with docs.tiddlyweb.com Mar 13, 2016
lib fixed whitespace Dec 23, 2012
profile Make profile/list_tiddlers.py work again v modern TiddlyWeb May 24, 2011
test Make tests pass in python 3.5 Feb 5, 2016
tiddlyweb Replace tiddlyspace docs references with docs.tiddlyweb.com Mar 13, 2016
.gitignore add pycache to ignore Jan 2, 2014
.travis.yml Update travis.yml to use containers Mar 13, 2016
CHANGES release 2.4.0 Nov 9, 2014
COPYRIGHT release 2.0.0 Jan 4, 2014
CREDITS Move the CREDITS and TESTING files up into root Sep 3, 2013
MANIFEST.in include wsgiapp in MANIFEST Jan 4, 2014
Makefile Fix ssh port for copies to peermore. Mar 13, 2016
README Reverse symlink relationship on README[.rst]. Nov 12, 2013
README.rst Replace tiddlyspace docs references with docs.tiddlyweb.com Mar 13, 2016
TESTING Move the CREDITS and TESTING files up into root Sep 3, 2013
UPGRADE1.0to1.2 tidies in the upgrade doc Aug 30, 2010
coverage tiddlyweb - make sure we flush a .figleaf file that sometimes Feb 16, 2009
index.cgi Fix index.cgi to use app_prefix as required by modern tiddlyweb. Mar 2, 2010
setup.cfg Address a rare 500 in list_bag_tiddlers Jul 19, 2013
setup.py Pin the html5lib requiremens so that sanitizers will work Oct 28, 2016
tiddlywebconfig.py Make printing error messages from twanager commands more simple. Jan 1, 2014
twanager In flight commit of python3 experiments Oct 24, 2013
wsgiapp.py Replace tiddlyspace docs references with docs.tiddlyweb.com Mar 13, 2016

README.rst

build status Package Version Package Downloads

For additional installation instructions see http://docs.tiddlyweb.com/

With the 2.0.0 release of TiddlyWeb versions 2.7 and 3.3 and beyond of Python are supported. Earlier versions may work but are not explicitly tested. Note that tiddlywebwiki and most plugins have not yet been ported to work with Python 3 but will work with 2.7. Work to bring them up to date is in progress.

Introduction

TiddlyWeb is an open source HTTP API for storing and accessing flexible and composable microcontent. It is also a toolkit for tiddlers on the web. Tiddlers are small chunks of optionally structured content with their own URI. The concept comes from TiddlyWiki. TiddlyWeb can provide the basis of a server side for TiddlyWiki. TiddlyWeb provides:

  • an abstract model (with default implementations) for:
    • authentication and authorization
    • entity storage
    • entity and collection serialization
  • a straightforward extension model via plugins
  • an implementation of authenticated recipes and bags allowing access to dynamically created and filtered collections of tiddlers
  • a clean and pragmatic HTTP API

The system is designed so that parts that are not optimal for a particular installation can be easily improved or swapped out via plugins.

While TiddlyWeb was initially designed as a TiddlyWiki server-side it can also be used as a generic data store and platform. The platform builds on concepts learned from TiddlyWiki, primarily the concept of the tiddler: a small chunk of data used to build up a greater whole.

TiddlyWeb includes a command line tool called twanager. Run twanager without arguments for a list of available commands.

Installation

The easiest way to install TiddlyWeb and all its dependencies is by using pip to install it from PyPI::

pip install -U tiddlyweb

If you wish to use TiddlyWeb as a server-side for TiddlyWiki to generate a multi-user TiddlyWiki system, you will also need tiddlywebwiki. This too can be installed via pip. Installing tiddlywebwiki will install tiddlyweb for you::

pip install -U tiddlywebwiki

Or you can install by hand, you will need the following requirements:

Building

Tests are run using PyTest:

make test

Coverage support with:

https://pypi.python.org/pypi/coverage https://pypi.python.org/pypi/pytest-cov

Miscellaneous

See http://pypi.python.org/pypi?%3Aaction=search&term=tiddlywebplugins for plugins that TiddlyWeb can use with itself.

If you have questions or contributions on making TiddlyWeb work for you, please post to the TiddlyWeb group at google groups:

http://groups.google.com/group/tiddlyweb

or contact the primary author, Chris Dent <cdent@peermore.com>.

Please report bugs and issues at the github issue tracker:

https://github.com/tiddlyweb/tiddlyweb/issues

There are a few tools that make exploring TiddlyWeb a bit easier:

License

TiddlyWeb is released under the BSD License and is copyright 2008-2016 UnaMesa Association.