轻松创建Plone项目、插件、文档！
项目描述
Cookieplone 🍪
欢迎使用Cookieplone，它是围绕Cookiecutter设计的强大包装，旨在简化Plone代码库的开发。无论您是构建后端插件、新的Volto插件、包含后端和前端的完整项目，甚至是文档，Cookieplone都通过使用健壮的Cookiecutter模板简化了整个过程。
主要功能 🌟
Cookieplone为每个受众提供了以下主要功能。
对于用户
- 所有Plone模板一站式服务：Cookieplone帮助您找到正确的模板以开始您的新的Plone项目。
- 简化使用：Cookieplone通过提供预定义的合理默认值和生成各种Plone项目的统一方法，在标准Cookiecutter使用之上提供了一种增强的体验。
- 包含所有功能：无需安装大量依赖项。运行
pipx run cookieplone，您将快速生成您的代码库。
对于模板创建者
- 内置验证器：包含内置验证器以确保用户输入正确。
- Jinja2过滤器：包含用于高级模板控制的Jinja2过滤器。
- 子模板：在cookiecutter钩子（例如post_gen_hook）中轻松实例化“子模板”的机制，便于代码重用。
安装 💾
首先，确保您的系统已安装Python、pip和pipx。
然后使用pipx安装Cookieplone。
# pipx is strongly recommended.
pipx install cookieplone
或者，如果pipx不可用，您可以在Python用户目录中安装Cookieplone。
python -m pip install --user cookieplone
用法 🛠️
要查看所有可用的模板选项，请运行
pipx run cookieplone
Cookieplone将引导您完成必要的步骤，使用合理的默认值，并在需要时提供自定义选项。
指定模板
您还可以指定其他模板。
| 模板 | 描述 | 命令 |
|---|---|---|
| backend_addon | 创建一个用于后端的Plone插件。 | pipx run cookieplone backend_addon |
| frontend_addon | 创建一个用于前端使用的Plone插件。 | pipx run cookieplone frontend_addon |
更新后的模板列表可以在cookieplone-templates存储库中找到。
配置Cookieplone
| 环境变量 | 描述 | 示例 |
|---|---|---|
| COOKIEPLONE_REPOSITORY | 查找要使用的模板的位置。 | COOKIEPLONE_REPOSITORY=/home/plone/cookiecutter-plone/ pipx run cookieplone |
| COOKIEPLONE_REPOSITORY_REF | 从远程存储库中使用的标签/分支。 | COOKIEPLONE_REPOSITORY_REF=experimental pipx run cookieplone |
| COOKIEPLONE_REPO_PASSWORD | 使用受密码保护的远程存储库时使用的密码。 | COOKIEPLONE_REPO_PASSWORD=very-secure pipx run cookieplone |
贡献 🤝
我们欢迎对Cookieplone的贡献。
您可以在问题跟踪器中创建问题，或联系维护者。
开发要求
- Python 3.10或更高版本
- Hatch
设置
安装所有开发依赖项，包括Hatch，并使用以下命令创建本地虚拟环境。
make install
检查和格式化代码库
make check
运行测试
pytest是此包的测试运行器。
使用以下命令运行所有测试。
make test
运行所有测试，但在遇到第一个错误时停止，并使用以下命令打开一个pdb会话。
hatch run test -x --pdb
使用以下命令运行匹配test_run_sanity_checks_fail的测试。
hatch run test -k test_run_sanity_checks_fail
使用以下命令运行匹配test_run_sanity_checks_fail的测试，但在遇到第一个错误时停止，并使用以下命令打开一个pdb会话。
hatch run test -k test_run_sanity_checks_fail -x --pdb
支持 📢
有关支持、问题或更多详细文档，请访问官方Cookieplone存储库。
感谢您选择Cookieplone满足您的Plone开发需求！
此项目由以下组织支持
许可证
该项目在MIT许可证下发布。
下载文件
下载适合您平台的应用程序。如果您不确定选择哪个，请了解有关安装软件包的更多信息。
源代码分发
构建分发
cookieplone-0.7.1.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 26ced2964a901f6b8ba60ba263ce9db719f88731b473bd413619878b34205979 |
|
| MD5 | e580182a6134d88a90f5dba0347c8806 |
|
| BLAKE2b-256 | 43ae84d655065d238d3cda350e8b3d1db8dc120266f8b5c275a8dc699bc8fab9 |
cookieplone-0.7.1-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 940aae8bcdb810358b41173310ad7157d3affa66e27bc6640350a5f7b50b9127 |
|
| MD5 | 2980fccc6ef80b6179a895d5ee4eda1e |
|
| BLAKE2b-256 | fcf86adc69dfd918523bc34542832eed655db69388dbdf6ef4eb62bb3dc28cbd |
