创建自定义pyscaffold扩展的pyscaffold扩展
pyscaffoldext-custom-extension的Python项目详细描述
PyscaffolText自定义扩展名
pyscaffold扩展,让您创建自己的自定义扩展。
说明
这个扩展为有兴趣为pyscaffold开发自己的扩展的用户提供了支持。它配置您的项目,以便您可以立即开始编写扩展逻辑和测试,并处理符合pyscaffold需要的所有连接。
假设您要创建名为notebooks的扩展名,该扩展名使用模板Jupyter notebook创建笔记本文件夹。使用以下命令安装此扩展之后:
pip install pyscaffoldext-custom-extension
您只需将其用于:
putup --custom-extension notebooks
这将创建一个典型的pyscaffold项目模板,并进行一些修改:
- 最上面的命名空间将是pyscaffoldext,以便为pyscaffold扩展提供统一的命名空间,
- 确保项目在setup.cfg中命名为pyscaffoldext-notebooks,
- 在setup.cfg, 中设置正确的setup_requires和install_requires以及options.entry_points参数
- 自动激活扩展名--no-skeleton,--pre-commit,--travis和 --tox因为我们需要干净编码的高质量扩展,
- 创建包含类Notebooks的extension.py模块,该类用作扩展的模板,
- 添加基本单元测试,检查对扩展的调用是否有效,以及它是否符合我们的flake8代码准则,
- 提供修改后的README.rst,指示这是pyscaffold扩展以及如何安装它。
注
有关pyscaffold及其扩展机制的更多信息,请查看http://pyscaffold.org/。