Cookieplone#
Your starting point for every Plone project.
Cookieplone generates Plone projects, add-ons, and documentation scaffolds from templates. This documentation covers Cookieplone 2.0.
Quick start#
uvx cookieplone
Cookieplone downloads the templates from cookieplone-templates, asks you a few questions, and generates the project.
Start here#
Pick the page that matches what you came to do:
Install Cookieplone—Install Cookieplone covers
uvx,uv tool install, and virtual environments.Create a Plone project—Create your first Plone project walks you through your first generation.
Build your own template—Create a template, then Template repositories.
Generate projects in CI—Automate with CI runs Cookieplone without questions.
Look something up—Reference covers the command line, the file formats, and the Python API.
Contribute to Cookieplone—Set up a development environment sets up a development environment.
Something is broken—Troubleshooting is organized by symptom.
Learn by doing. Generate your first Plone project, or build a template repository from scratch.
Run Cookieplone in CI, update an existing project, use a custom template repository, and write templates with validators, computed fields, filters, and hooks.
The command line, environment variables, configuration, the repository and template formats, validators, filters, and the Python API for hooks.
How Cookieplone works: template repositories, hooks, sub-templates, validators and filters, computed defaults, and answers.
Symptoms, causes, and fixes for the failures you're most likely to meet.
What you need#
Python |
3.10, 3.11, 3.12, 3.13, or 3.14 |
uv |
To run Cookieplone with |
git |
To use templates from a git repository, including the default one |
The official templates check for more tools, such as Node.js. See Install Cookieplone for each template's requirements, and Compatibility for supported versions.