跳转到主要内容

Kotti 的 Paster 插件模板

项目描述

kotti_paster

kotti_paster 为创建 Kotti 项目或插件提供“入门级”框架。有关详细文档,请参阅 Kotti 文档

警告

“kotti_paster”的继任者是bobtemplates.kotti,它将不再进一步开发。如果您是Kotti开发的初学者并且对开发主题或插件感兴趣,您可能希望与mr.bob结合使用bobtemplates.kotti。然而,如果您想显式使用templer或寻找一个脚手架来为您自己的kotti插件创建buildout结构,您就找到了正确的位置。

安装

您只需使用easy_install从PyPi安装此软件包。这将安装PasteScript和Cheetah。因此,您可能想创建一个新的virtualenv来安装它。

$ easy_install kotti_paster

安装后,您还有两个额外的paster模板:kotti_projectkotti_addon

创建项目

kotti_project脚手架允许您轻松地为Kotti生成基于buildout的项目。您可以使用虚拟env中的“paster create”命令来完成此操作。

$ paster create -t kotti_project my_project_name

这将创建一个名为my_project_name的buildout,其中包含一个名为my_project_name的开发包。

要运行buildout项目引导,请运行buildout,然后使用pserve启动您的项目。

$ cd my_project_name
$ python boostrap.py
$ ./bin/buildout
$ ./bin/pserve development.ini

服务器将在默认的6543端口上启动。访问https://:6543以查看带有您插件的Kotti。

插件包含示例代码 - 更改它并添加您想要的特色内容。有关更多信息,请参阅Kotti文档

有一些参数可以调整项目以满足您的需求。某些选项仅在交互式提示的专家模式下可用,因此如果您想覆盖选项omelettecodeintelsupervisor的默认值,请选择此模式。

如果您使用git作为版本控制系统,项目中的.gitignore文件很有用。默认情况下,将创建此文件。如果您不需要它,设置选项gitignore=false

$ paster create -t kotti_project my_project_name --no-interactive gitignore=false

如果您计划在github上托管您的项目,travis是设置持续集成的一种方便的方式,几乎不需要努力。将参数travis=true添加到命令行,项目中将集成一个名为.travis.yml的文件。此选项默认为false

$ paster create -t kotti_project my_project_name  --no-interactive travis=true

omelette是一个设置目录结构的配方,该目录结构与实际的Python命名空间相匹配,并具有指向egg内容的符号链接。如果您的buildout中不包含此内容,您可以将其排除。

$ paster create -t kotti_project my_project_name --no-interactive omelette=false

codeintel配方为SublimeCodeIntel(一个SublimeText插件)生成配置文件,这对您非常有用,但仅当您使用SublimeText作为您的编辑器并且已安装该插件时。使用命令行选项codeintel来激活此选项。

$ paster create -t kotti_project my_project_name --no-interactive codeintel=true

supervisor配方将supervisor部分集成到您的buildout中。Supervisor是一个客户端/服务器系统,它允许用户在类UNIX操作系统上监控和控制多个进程。更多关于它的信息请参阅supervisor文档。在命令行上将supervisor=true设置为在您的buildout中获得此部分。

$ paster create -t kotti_project my_project_name --no-interactive supervisor=true

创建插件

“kotti_paster”的主要任务是提供一个脚手架,它允许您轻松地为Kotti生成插件。您可以使用虚拟env中的pcreate命令来完成此操作。

kotti_addon 框架允许您为 Kotti 创建一个插件

$ paster create -t kotti_addon my_addon_name

这将在这个目录下创建一个名为 my_addon_name 的包。您可以在自己的虚拟环境中使用此包进行开发,或者将其添加到您的 buildout.cfg

[sources]
...
my_addon_name = fs my_addon_name

[application]
...
eggs =
    my_addon_name

和您的 development.ini

kotti.configurators =
    ...
    my_addon_name.kotti_configure

您可以在 Kotti 开发手册的 内容类型部分 找到 Kotti 内容类型的示例,了解更多信息

$ paster create -t kotti_addon my_addon_name --no-interactive content_type=true

此插件包含示例代码 - 更改它并添加您的高级功能。有关更多信息,请参阅 Kotti 文档。在文档中,您将找到一个 教程,其中提供了有关如何使用 kotti_paster 启动插件的更多信息。

变更日志

0.2 (2013-10-18)

  • 更新到使用 Kotti 9.2.0。[j23d]

  • 修复翻译的域。[jon1012]

0.1 (2012-12-12)

  • 直接从 Kotti 自身使用开发需求。[j23d]

  • 将 static.py 重命名为 fanstatic.py 以保持一致性。[j23d]

  • 添加了一个使用 pytest 固定装置的测试示例。[j23d]

  • 添加了插件的自定义 ini 文件。[j23d]

0.1a3 (2012-11-08)

  • 将导入更改为 PEP8 风格。[disko]

  • 将 entry_points 更改为字典风格。[disko]

  • 修复 gitignore 模板中的错误。[disko]

  • 更新到 Kotti >= 0.8

    • 在 kotti_configure 中使用 fanstatic 包含。[disko]

    • 使用表单类而不是通用表单函数。[disko]

0.1a2 (2012-09-25)

  • 将 Cheetah 锁定为满足 templer.core 的需求。[disko]

0.1a1 (2012-09-25)

  • 第一个公开版本。

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面