This is about developing with the TiddlyWeb core. If you are interested in plugins start with Customizing TiddlyWeb.

Code Structure

TiddlyWeb code base has two important directories:

• tiddlyweb

  The actual TiddlyWeb code.

  
  
• test: A suite of test files for the code.
  
  

The code tries to comply with pep8 and is run through pylint every now and again to see where things could do with some help. If you are submitting a patch we like four spaces not tabs. We likes patches.

Dependencies are listed in the README and setup.py files. The Makefile is used to automate the distribution process.

Testing

• The TiddlyWeb tests are in a form that works well with py.test, chosen because it is has low overhead. From the base directory run py.test to run all the tests. See the tiddler for more options.
  
• Running all the tests requires YAML, wsgi_intercept and httplib2.
  
  

From the base directory of the code, you can run all the tests with py.test, py.test test or make test. You can run one or more tests by naming them on the command line: py.test test/test_filter.py test/test_bag.py.

You must run the tests from the base directory of the TiddlyWeb code.

By default py.test will run every test it sees until it gets to the end, regardless of errors. If you would like it to quit on the first failure give -x as an argument. By default py.test also captures output from the tests. If you don't want this give -s as an argument.

When a test run by py.test fails to pass, figuring out what went wrong can be quite challenging. You'll need to dig through the scrollback of your terminal window to see what's going on, and then likely need to stick some prints in your tests and do some -s stuff on the command line. This may seem like a big hassle, but surprisingly, after some time it works well.

External Resources

• TiddlyWeb Plugins
  
• TiddlyWeb Plugin Tutorial
  
• Example TiddlyWeb Plugins