tiddlywebplugins.mapuser 0.1.0

Allows TiddlyWeb users to create alias usernames, deliberately without validation.

Requirements

• [Python](http://www.python.org/).
• [pip](http://www.pip-installer.org/en/latest/).
• make.
• A working TiddlyWeb instance to test against.
• [py.test](http://pytest.org/latest/) to run the tests.

Modifying

The best way to figure out how to work with this project is to look at the .travis.yml file.

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

Plugin code lives in the tiddlywebplugins directory.

Tests live in the test directory.

• make install installs the plugin as a package on your system
• make install_dev installs packages necessary to run tests, check style and provide test coverage
• make test runs the tests.
• make test_with_coverage runs the tests with code coverage reporting from pytest-cov
• make pep8 runs pep8 over the code to check for style compliance.

(you may need sudo for this.) * make release packages and uploads the plugin to [PyPI](http://pypi.python.org/pypi) for distribution.

Plugin Installation

Install tiddlywebplugins.mapuser:

pip install -U tiddlywebplugins.mapuser

TiddlyWeb Configuration

Reference the plugin from your TiddlyWeb configuration as a system plugin e.g:

'system_plugins': ['tiddlywebplugins.mapuser']

Usage

The URL to send POSTs to will be:

map_user/<userid>

Where <userid> is the same as the one used to authenticate. The body will contain the mapped username:

mapped_user: <username>