setuptools的wiki页面上传命令插件
WikiUp的Python项目详细描述
- 1.1中的新功能:
- 现在--changed-file或-f选项允许您指定单个 要上载的文件。(详细信息请参见下面的Command-Line Usage。)
wikiup项目定义了一个setuptools扩展来允许上传wiki 来自源文档的页面。它主要用于 peak项目更新peak wiki,但其他项目可以利用 相同的基本框架。
安装此项目会将wikiup命令添加到基于setuptools的包中。 默认情况下,此命令将读取项目中名为wikiup.cfg的文件 包含如下内容的目录:
[wikiname] pagename = filename
换句话说,一个文件,每个wiki有一个节,pagename+文件名 在每条线上。(文件名实际上是可选的;如果您只是列出一个页面名 如果没有=,则假定文件名与页面相同 name.)文件名必须相对于安装目录,并使用/as 分隔符,因为它们将使用distutils转换为操作系统路径 convert_path()函数。
要配置wiki,需要将其添加到distutils配置文件(通常 你的$HOME/pydistutils.cfg或~/.pydistutils.cfg文件)喜欢这样:
[wikiup-wikiname] url = base url here type = plugin name here ... other settings, if any
换句话说,对于每个wiki,您需要一个[wikiup-foo]部分,其中 foo是wiki的名称,它将出现在某些项目的 wikiup.cfg文件。
url是wiki的基本url,type是 用来上传。当前,^{tt14}唯一支持的值$ 是OldMoin,它与peak使用的旧moinmoin wiki一起工作 项目。
命令行用法
setup.py wikiup命令可以选择使用--comment或-c 选项指定编辑时要应用的更新注释。也可以是 给定--config-file或-C以指定替代配置文件 本地wikiup.cfg文件的。
另外,如果您有许多wiki页面,您可以只指定一个文件名 使用--changed-file或-f更新。文件将上载到所有 项目的wikiup.cfg中的匹配页。(注:此选项是 区分大小写,并且必须与wikiup.cfg中的一个或多个文件名完全匹配, 否则不会上载任何内容。)
OldMoin插件
OldMoin插件的配置中有两个可选参数 部分,除了所需的type和url:
[wikiup-foo] type = OldMoin url = something uid = login.id.goes.here page_format = {{{ %s }}}
uid允许您指定要使用的moinMoin登录ID;如果指定, 插件将使用userformwiki操作作为该id登录 上传任何页面。
page_format是格式字符串(默认为"#format rst\n%s") 将用于将原始上载文件转换为将 发布到wiki。字符串使用^{tt35}解释$ 编解码器,所以你需要在反斜杠上加倍以防止它们 作为字符转义处理。
添加插件
通过子类化,您可以为其他wiki类型实现其他插件。 wikiup.Wiki并在^{tt37}中注册生成的类$ 入口点组。有关插件必须是什么的详细信息,请参见源代码 能够做到。
支架
此包的问题、注释和错误报告应指向 PEAK mailing list。