跳转到主要内容

PyScaffold扩展,用于创建自定义PyScaffold扩展

项目描述

Build Status ReadTheDocs Coveralls PyPI-Server

pyscaffoldext-custom-extension

PyScaffold扩展,允许您创建自己的自定义扩展。

描述

此扩展为对开发自己 PyScaffold 扩展感兴趣的用户提供支持。它配置了您的项目,以便您可以直接开始编写扩展逻辑和测试,并处理所有符合 PyScaffold 需求的连接工作。

假设您想创建一个名为 notebooks 的扩展,它创建一个包含一些模板 Jupyter notebook 的笔记本文件夹。安装此扩展后

pip install pyscaffoldext-custom-extension

您可以直接使用它

putup --custom-extension notebooks

这将创建一个典型的 PyScaffold 项目模板并进行一些修改

  • 最顶层的命名空间将是 pyscaffoldext,以便为 PyScaffold 扩展提供一个统一的命名空间,

  • 确保在 setup.cfg 中将软件包(作为 pip/PyPI 看到它)命名为 pyscaffoldext-notebooks

  • setup.cfg 中设置了正确的 install_requires 以及 options.entry_points 参数,

  • 自动激活扩展 --no-skeleton--pre-commit--cirrus,因为我们希望编写干净、高质量的扩展,

  • 创建一个包含一个类(作为您扩展的模板)的 extension.py 模块,

  • 添加基本单元测试以检查您的扩展调用是否正常,并且它符合我们的 flake8 代码规范,

  • 提供了一个修改后的 README.rst,说明这是一个 PyScaffold 扩展以及如何安装它。

修改内容 & 贡献

此项目使用 pre-commit,在做出任何更改之前,请确保已安装它

pip install pre-commit
cd pyscaffoldext-custom-extension
pre-commit install

更新挂钩到最新版本是个好主意

pre-commit autoupdate

请查看 PyScaffold 的 贡献指南

注意

有关 PyScaffold 及其扩展机制的更多信息,请访问 https://pyscaffold.org/

项目详情


下载文件

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

源分发

pyscaffoldext-custom-extension-0.6.3.tar.gz (25.2 kB 查看哈希值)

上传时间

构建分发

pyscaffoldext_custom_extension-0.6.3-py2.py3-none-any.whl (14.3 kB 查看哈希值)

上传时间 Python 2 Python 3

由以下支持

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