跳转到主要内容

帮助Zope 3项目快速启动的工具

项目描述

Zope 3社区的项目构建器

z3c.builder 是一个工具,可以帮助您通过为您生成所有样板代码和配置来快速启动 Zope 3 应用程序的开发。

目标

  • 易于使用

  • 易于扩展

  • 更或更完整的

头脑风暴

最简单的事情是生成所有必要的文件,而不一定是可定制的。一个基于最小 eggs 和 buildout 的项目结构可能如下所示

package-name/
  bootstrap.py
  buildout.cfg
  setup.py
  README.txt
  CHANGES.txt
  src/
    namespace-package/
      __init__.py
      package/
        __init__.py

此目录结构的每个部分都可以进一步配置,直至无穷。困难的部分是决定何时足够。让我们考虑每个部分及其提供的功能。

bootstrap.py

这是极其简单的。有一个标准文件,每个人都在使用,我们只需要将其复制过来。我认为没有潜在的可定制点。

buildout.cfg

您可以对 buildout.cfg 文件进行大量通用自定义。以下是我们可能希望开箱即支持的其中一些

  • 创建多个 buildout.cfg 文件,用于不同的用途(开发者、生产、最小?)

  • kgs 连接,支持使用远程 extends buildout 选项,或在新项目创建时下载 versions.cfg 文件。

  • 一些通常使用且有用的部分:- 测试 - 覆盖率 - Python 解释器 - ctags - 文档生成器

    (请注意,其中一些部分需要添加额外的文件到 src 树中才能有意义)

    (注意,其中一些部分需要添加额外的文件到 src 树中才能有意义)

  • Zope 服务器设置。这涉及到我们可能想要做的所有 Zope 3 配置,以及 paster 设置。这基本上包括您可以在 zope.conf 文件中配置的任何内容。

setup.py

这相对简单直接。有传递给 setup() 命令的明显关键字参数,我们想要配置。然而,还有一些稍微有趣的部分

  • long_description: 由于这将成为Python页面,我们将希望将用于使用README.txt、CHANGES.txt和其他文件的样板代码组合起来,以生成完整的详细描述。这不应该太难。

  • classifiers: 记住所有不同的分类器和它们的格式总是很痛苦。

  • extras_requires: 我们可能想要配置哪些extras_requires部分。通常我们会有测试和应用程序部分。还可能有文档部分和其他部分。

  • entry_points: 这里有点棘手。Paster有其自己的入口点样板代码,你需要它。我们可能还想要配置任意数量的额外命令行脚本入口点。

README.txt

只是一个简单的文件转储,可能包含一些可配置的初始内容。

CHANGES.txt

另一个简单的文件转储,包含我们标准化的变更日志格式的示例。

其他Python文件

其余的文件只是为了制作适当的Python模块,应该非常简单。

结论

我认为从为简单的egg/buildout项目创建项目构建器开始是一个好的起点。这是一个可实现的且有用的目标,这将为我们提供应对更复杂的zope样板任务所需的经验。

CHANGES

版本 0.1.0(2009-03-27)

  • 初始发布

项目详情


下载文件

下载适用于您平台的项目文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码分发

z3c.builder.core-0.1.0.tar.gz (140.9 KB 查看哈希值

上传时间 源代码

支持者