Cookiecutter Plone Distribution

Powered by Cookiecutter, Cookiecutter Plone Distribution is intended to be used by Plone integrations willing to implement their own Plone Distributions.

A Plone distribution is a pre-packaged version of Plone that includes specific features, themes, modules, and configurations. It is a convenient way to get a specific type of website up and running quickly, as the distribution includes everything needed to run that type of site.

Getting Started 🏁

Prerequisites

• pipx: A handy tool for installing and running Python applications.

Installation Guide 🛠️

1. pipx

pip install pipx

Generate Your Plone 6 Distribution 🎉

pipx run cookiecutter gh:collective/cookiecutter-plone-distribution

Project Generation Options

These are all the template options that will be prompted by the Cookiecutter CLI before generating your project.

Option	Description	Example
distribution_title	Your project's human-readable name, capitals and spaces allowed.	Blog
description	Describes your project and gets used in places like README.md and such.	Create awesome blogs with Plone.
author	This is you! The value goes into places like LICENSE, setup.py and such.	Our Company
email	The email address you want to identify yourself in the project.	[email protected]
github_organization	Used for GitHub and Docker repositories.	collective
python_package_name	Name of the Python package used to configure your project. It needs to be Python-importable, so no dashes, spaces or special characters are allowed.	collective.blog
default_language	Default language for this distribution.	en
include_features	Should we keep the distribution simple, or also add features	0

Code Quality Assurance 🧐

Your package comes equipped with linters to ensure code quality. Run the following to automatically format your code:

make format

Internationalization 🌐

Generate translation files with ease:

make i18n

License 📜

This project is licensed under the MIT License.

Let's Get Building! 🚀

Happy coding!