brewblox/brewblox-history

BrewBlox服务插件样板代码

创建BrewBlox服务插件时需要一些样板代码。本仓库可通过分叉（fork）来避免重复进行繁琐的配置工作。

必要修改部分下列出的所有内容必须完成，软件包才能按预期工作。

如何使用

• 将本仓库分叉到您自己的Github账户或项目中
• 按照各个必要修改部分中列出的所有步骤操作
• 开始编写您的插件代码 =)

文件说明

setup.py

用于创建可分发和可安装的Python软件包。更多信息参见Python官方文档。

必要修改：

• 将project_name变量更改为您的项目名称。通常与仓库名称相同。此名称用于通过Pip安装软件包。
• 将package_name变量更改为模块名称。可以与项目名称相同，但不能包含连字符-。此名称用于在Python中导入软件包。
• 检查其他所有字段是否正确。有关更多信息，请参考文档。
• 将url参数更改为您的仓库URL。
• 将author参数更改为您的姓名。
• 将author_email参数更改为您的***。

tox.ini

此文件用于启动软件包的自动化测试和代码检查。更多信息参见Tox官方文档。

必要修改：

• 将--cov=YOUR_PACKAGE更改为引用您的模块名称。
• --cov-fail-under=100会在代码覆盖率低于100%时导致构建失败。这是可选的，但推荐使用。移除#注释字符以启用此功能。

requirements.txt

在此处包含软件包的所有运行时依赖项。更多信息参见Pip官方文档。

注意： 此依赖文件与setup.py中的install_requires=[]行存在重叠。在大多数情况下，经验法则是：如果需要外部软件包才能运行，应将其添加到两个文件的依赖项中。

requirements-dev.txt

此文件的作用与requirements.txt相同，但应仅列出测试代码所需的软件包。最终用户不需要这些依赖项。

MANIFEST.in

此文件列出应包含在软件包中的所有非代码文件。更多信息参见Python官方文档。

对于基本插件，无需修改此文件。

.travis.yml

Travis CI配置文件。如果您尚未为仓库启用Travis：无需担心，它不会执行任何操作。

.coveragerc

此文件包含pytest-cov的一些配置。

对于基本实现，无需修改此文件。

README.md

您的模块自述文件（本文件）。它将作为Pypi.org上的软件包描述，并在Github中自动显示。 必要修改：

• 在此处添加关于您的软件包的所有重要信息。您的软件包有什么功能？如何使用？您最喜欢的颜色是什么？

YOUR_PACKAGE/

您的模块。此目录名称应与setup.py中的package_name变量匹配。 必要修改：

• 重命名为所需的模块名称。（Python导入名称，不能包含连字符-）。

test/conftest.py

项目级别的pytest fixtures。此处定义了一些用于测试任何brewblox_service实现的有用fixtures。有关如何使用的示例，请参见https://github.com/BrewBlox/brewblox-service/tree/develop/new/test%E3%80%82

对于基本实现，无需修改此文件。

test/test_hello.py

关于如何测试您添加的aiohttp端点的示例。一旦不再需要，可以删除此文件。