Cookieplone 🍪

Welcome to Cookieplone, your starting point for every Plone project. Whether you're building an add-on, starting a new project, or even creating your own Plone Distribution, Cookieplone simplifies the process by using templates maintained by the Plone Community in cookieplone-templates.

Read the full documentation at plone.github.io/cookieplone.

Key features 🌟

Cookieplone offers the following key features for each audience.

For users

• One stop for all Plone templates: Cookieplone lists the official templates by category, and helps you pick the one for your new Plone project.
• Simplified usage: Cookieplone asks only the questions a template needs, with sensible defaults, checks your answers, and shows them for review before it generates anything.
• No installation needed: Run uvx cookieplone, and you will quickly generate your codebase.

For template creators

• Template repositories: Group templates in a repository with a cookieplone-config.json, hide internal templates, and extend another repository, such as cookieplone-templates, instead of forking it.
• Built-in validators: Includes built-in validators to ensure user inputs are correct.
• Jinja2 filters: Includes Jinja2 filters for advanced template control.
• Sub-templates and hook helpers: Generate sub-templates and run common post-generation actions from your template's hooks, facilitating greater code reuse.
• pytest plugins: Test your templates with fixtures that Cookieplone provides.

See Create a template to get started.

Installation 💾

Cookieplone needs Python 3.10 or later, uv, and git. Each template checks for the other tools it needs, such as Node.js or Docker, before it asks its first question.

See Install Cookieplone for the requirements of each template, and Plone's Prerequisites for installation for your operating system.

Usage 🛠️

Use uvx (command installed by uv) to run cookieplone and choose a template from its menu:

uvx cookieplone

It is also possible to run a specific version of Cookieplone:

uvx cookieplone@2.0.0

Cookieplone will walk you through the necessary steps, using sensible defaults and offering customization options where needed. The tutorial Create your first Plone project walks through a complete run.

Try a prerelease version

Plain uvx cookieplone (and uvx cookieplone@latest) always picks the latest stable release — prerelease versions (aN, bN, rcN, .devN) are excluded by default, following PEP 440 and the uv resolver defaults.

To opt in to a prerelease — for example, 2.1.0a1 — pin the exact version:

uvx cookieplone@2.1.0a1

Or allow the resolver to consider any prerelease:

uvx --prerelease=allow cookieplone

If you previously installed Cookieplone with uv tool install, reinstall the tool explicitly so the cached stable install is replaced:

uv tool install --reinstall --prerelease=allow cookieplone

You can confirm which version is active with:

uvx cookieplone --version

See Use a prerelease version of Cookieplone for details.

Specify a template

Pass a template ID to skip the menu:

uvx cookieplone project

These are the templates of cookieplone-templates:

Each template's page lists its requirements, questions, and generated files. uvx cookieplone --all also shows the hidden templates.

Use options to avoid prompts

Cookieplone will ask a lot of questions. You can use some of its options to avoid repeatedly entering the same values.

key=value

Pass answers after the template ID, such as uvx cookieplone project title="My Site". In an interactive run, they pre-fill the questions. See Set answers with extra context.

--answers-file

Point --answers-file (or --answers) to a JSON file with the answers you want to use to pre-populate default values.

--no-input

Use --no-input to make Cookieplone not prompt for questions and use the default values, the answers file, and key=value pairs instead. Cookieplone still validates each value.

--replay and --replay-file

Use --replay to generate a project again with the answers of your previous run of the same template, or --replay-file to read them from a file. See Answers and replay.

All options are listed in the CLI reference.

Configure Cookieplone

See the environment variables reference for all variables. If something goes wrong, check Troubleshooting.

Contribute 🤝

We welcome contributions to Cookieplone.

You can create an issue in the issue tracker, or contact a maintainer. Report issues with a template, or propose a new one, in the cookieplone-templates repository.

• Issue Tracker
• Source Code
• Templates

Branches

All new feature development targets the main branch. The 1.x branch is in maintenance mode and only receives bug fixes and minor improvements released as 1.x versions.

Development requirements

See Installation, and Set up a development environment for the full guide.

Setup

Create a local Python virtual environment and install the pre-commit hooks with the following command.

make install

Run the checked out branch of Cookieplone

uv run cookieplone

Check and format the codebase

make lint

make format runs the same checks and fixes what it can.

Run tests

pytest is this package's test runner.

Run all tests with the following command.

make test

Run all tests, but stop on the first error and open a pdb session with the following command.

uv run pytest -x --pdb

Run only tests that match test_run_sanity_checks_fail with the following command.

uv run pytest -k test_run_sanity_checks_fail

Run only tests that match test_run_sanity_checks_fail, but stop on the first error and open a pdb session with the following command.

uv run pytest -k test_run_sanity_checks_fail -x --pdb

Work on the documentation

Build the documentation, and run its checks, with the following commands.

make docs-html
make docs-test

Support 📢

For support and questions, read the documentation, search the issue tracker, or ask in the Plone Community Forum.

Thank you for choosing Cookieplone for your Plone development needs!

This project is supported by

License

The project is released under the MIT License.