跳转到主要内容

一个基于最佳实践和现代实用模板的复杂模板生成器

项目描述

goli

Build status Python Version Dependencies Status

Code style: black Security: bandit Pre-commit Semantic Versions

License

一个基于最佳实践和现代实用模板的复杂模板生成器

注意: 该项目深受cookiecutter启发,旨在创建一个包含过去几年中证明有用的现代模板的优秀集合。

为什么还需要另一个模板生成器?

我喜欢cookiecutter包,并且已经使用它多年。然而,这个领域变化太快,我使用的许多cookiecutter模板现在都已过时。因此,我发现自己总是在谷歌、GitHub等地方寻找新的模板,浪费了大量的时间。

因此,我想创建这样一个简单的工具,其中集成了过去几年中证明有用的所有实用模板,并遵循该领域的最佳实践。

请注意,goli不仅限于Python。它也可以用于其他语言,我计划在未来添加其他功能。

安装

pip install -U goli

或者使用 Poetry 安装

poetry add goli

然后您可以通过运行 goli --help 来显示如何使用该包的帮助信息

Usage: goli [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  languages  Show all supported programming languages
  new        Generate new boilerplate code for your project
  topics     Show all supported topics.

如您所见,goli 提供了三个命令。语言和主题命令是额外的,用于获取更多关于如何使用包的信息。新命令是最重要的,用于启动一个新项目。更多内容将在下一节中介绍。

用法

goli 提供了新命令,该命令用于创建一个新的样板代码,这取决于您需要提供的两个可选参数。

  • language 参数,表示您想要使用或将在项目中使用的编程语言。您可以运行 goli languages 来检查支持的语言

  • topic 参数,应表示您的项目主题。您可以运行 goli topics 来检查 goli 支持的主题

例如,以下是我将使用 python 启动数据科学项目时命令的示例

goli new --language python --topic data-science

或简短版本

goli new -l python -t data-science

这将拉取 modern cookiecutter-data-science 模板(https://github.com/drivendata/cookiecutter-data-science)并在您当前的工作目录中执行它。因此,您不需要搜索模板,因为最佳实践已经内置,并且会定期更新。

常见问题解答

我想添加 goli 中找不到的有用的模板

如果您想贡献并添加模板,请访问 goli/cookiecutters.py,将您的模板作为类成员变量添加,并在相应的语言和主题下将它们添加到 repos 字典中。

项目详情


下载文件

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

源代码分发

goli-0.1.1.tar.gz (6.0 kB 查看散列

上传时间 源代码

构建分发

goli-0.1.1-py3-none-any.whl (6.3 kB 查看散列

上传时间 Python 3

支持者:

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