Manage an app for TiddlySpace.
tsapp provides a tool,
tsapp, for creating browser-based applications
for use with [TiddlySpace](http://tiddlyspace.com/). Such applications are
files for presenting and access the tiddler data that lives in TiddlySpace.
The combination can be very useful for rapid development of web applications that need a persistent but simple data store with a clean, robust API.
tsapp is a Python 2 based tool. You will need a Python installation (2.5
pip is used for installation. If you don’t have pip you can
learn how to get it [here](http://www.pip-installer.org/).
` pip install -U tsapp `
Once installed the
tsapp script should be on your
tsapp provides a single script that takes multiple commands. Running
tsapp help will list the relevant commands. The following lists
available commands. Those commands which are not yet completed are marked
Note that the commands are designed to allow easy creation of aliases and to otherwise be combined in a useful fashion using the shell.
tsapp init <app name>
Create an app directory named whatever you give you for
Inside the directory will be a stub
index.html file and an assets
index.html is used as the primary access page of your
Run a local web server that will serve up your HTML file and other assets.
Any assets which are not found locally will be looked for at the target
TiddlySpace server (see configuration below). Paths to
/bags/<somebag>/tiddlers/<sometiddler> will first try to load
assets/<sometiddler> locally. If that is not found, then the original
path will be looked up on the TiddlySpace server.
The proxy server will always send
to the target server.
The goal with this arrangement is to allow the local files to not have to change when pushed to the target server for eventual hosting.
tsapp push <bag name> [<tiddler title>]
Push (via HTTP
PUT) all the local assets to the target server, in the
bag named by
<bag name>. If the bag does not end with
_public will be appended.
Files that have a
.tid extension on the source file will
have the extension removed on the target.
<tiddler title> is provided, just that one tiddler will be pushed.
tsapp auth <username>
Authenticate to the target_server as username and write the resulting auth token to the local directory’s configuration file.
tsapp delete <bag name> <tiddler title>
A convenience method for removing a tiddler that’s ended up on the server that is no longer needed and may be in the way.
tsapp looks for a
.tsapp configuration file in the current user’s
and in the current directory.
$HOME/.tsapp overrides defaults and
$HOME/.tsapp. There is no requirement for a configuration
file in the home directory if one is not desired. However, in order
push command to work, a
.tsapp containing an
be found. The
auth command will create one.
Make sure that you do _not_ commit a .tsapp file that includes the auth_token.
The fields are:
The URL (without trailing
/) of the home tiddlyspace server. Defaults to
The hostname or IP to which to bind the local proxy. Default is
The port to which to bind the local proxy. Default is
Auth secret for accessing private resources on the target server. No default.
Set it with the
auth command or copy in the tiddlyweb_user cookie.
- http://tsapp.tiddlyspace.com/ provides a simple docs interface,
Thanks to @bengillies for his
tsupload script which provided some of the
motivation for creating this.