管理tiddlyspace的应用程序。
tsapp的Python项目详细描述
摘要
==
tsapp提供了一个工具“tsapp”,用于创建基于浏览器的应用程序
与[tiddlyspace]一起使用(http://tiddlyspace.com/)。这些应用程序由一个或多个html文件以及一个或多个css和javascript文件组成,用于呈现和访问tiddlyspace中的tiddler数据。
健壮的api。
install
==
tsapp是一个基于python 2的工具。您需要安装python(2.5
及更高版本)。` pip`用于安装。如果你没有pip,你可以在这里学习如何获得它(http://www.pip-installer.org/)。
`````
pip install-u tsapp
````
运行
`tsapp help`将列出相关命令。下面列出了可用的命令。那些尚未完成的命令用“tbc”标记为
。
`
创建一个应用程序目录,命名为您为`<;app name>;``提供的任何内容。
目录中有一个stub'index.html'文件和一个assets
目录。` index.html`用作
应用程序的主访问页。javascript、css和其他文件放在资源中。
serve
----
运行本地web服务器,为html文件和其他资源提供服务。
将在目标tiddlyspace服务器(请参阅下面的配置)中查找未在本地找到的任何资源。指向
`/bags/<;somebag>;/tiddler/<;sometiddler>;`的路径将首先尝试在本地加载
`assets/<;sometiddler>;'。如果找不到该路径,则会在tiddlyspace服务器上查找原始路径。
`向目标服务器发送和删除请求。
当配置通过时,将启动服务器。
push
----
`tsapp push<;bag name>;[<;tiddler title>;]`
push(通过http“put”将所有本地资产推送到目标服务器,位于由“<;bag name>”命名的
包中。如果包没有以“u private”或
“u public”结尾,则将追加“u public”。例外情况是,如果在配置中将
`tiddlyweb\u mode'设置为true。
在源文件上具有“.html”或“.tid”扩展名的文件将
在目标文件上删除扩展名。
如果提供了“<;tiddler title>;”,只推送一个tiddler。
push_hard
--
`tsapp push_hard<;bag name>;[<;tiddler title>;]`
push(通过http“put”将所有本地资产推送到目标服务器,位于由“<;bag name>”命名的包中。如果包没有以“u private”或
“u public”结尾,则将追加“u public”。例外情况是,如果在配置中将
`tiddlyweb\u mode'设置为true,
此命令与“push”不同,因为
服务器上的目标文件在“put”之前被删除。
tiddler title>;`提供,只推送一个tiddler。
auth
---
将令牌验证到本地目录的配置文件。
delete
----
一种方便的方法,用于删除结束于
服务器上的不再需要的、可能会妨碍您的整理程序。
配置
==
tsapp在当前用户的“$home”和当前目录中查找“.tsapp”配置文件。`$home/.tsapp`覆盖默认值和
`./.tsapp`覆盖`$home/.tsapp`。如果不需要,则不需要在主目录中配置
文件。但是,要使“push”命令工作,必须找到包含“auth\u令牌”的“.tsapp”。“auth”命令将创建一个.tsapp文件。
确保不提交包含
auth令牌的.tsapp文件。
字段为:
target\u server
----
home tiddlyspace server的url(不带尾随的`/`)。默认为
`http://tiddlyspace.com`.
local_host
----
要将本地代理绑定到的主机名或IP。默认值为“0.0.0.0”。
port
----
要将本地代理绑定到的端口。默认值为“8080”。
auth_token
——
auth secret用于访问目标服务器上的专用资源。没有默认值。< BR/>将它与“Auth'命令或副本设置在TIDDYLWebHub用户cookie中。
BR/>也将设置AutoStand属性(仅当它不存在时)
当服务器截取登录请求为“/挑战/
< BR/>”时,如果设置了“注销”/“退出”,并且AutoStIONTION存在,则将从配置中删除“BR/>”。本地目录。
wsgi_sever
——
包含“start_server”方法的python模块的名称,当传递“config”时,
将启动托管代理
应用程序的web服务器。最初这是python stdlib中的wsgiref
模块提供的服务器,但事实证明这非常慢。
现在使用的是cherrypywsgiserver。使用原始
服务器[可用](https://gist.github.com/cdent/5564147)的示例。
当
推送资产时,tsapp不会将“u public”或“u private”附加到包中。
使用“auth”命令时,此选项还将确保使用默认的tiddlyweb身份验证
挑战者。
server-prefix
----
url前缀(不带任何`/`)
添加到`/bags/<;somebag>;/tiddlers/<;sometiddler>;`用于验证、查找、推送和删除资产。这仅限于单个段,例如前缀“web”将完成路径:
`/web/bags/<;somebag>;/tiddler/<;sometiddler>;`
示例
=
*http://tsapp.tiddlyspace.com/提供一个简单的文档界面,
用“tsapp”创建。