README.md

Cookiecutter Plone Addon

Powered by Cookiecutter, Cookiecutter Plone Addon is intended to be used by Plone developers to create new addon packages.

Getting Started 🏁

Prerequisites

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

Installation Guide 🛠️

1. pipx

pip install pipx

Generate Your Plone Addon 🎉

pipx run cookiecutter gh:plone/cookiecutter-plone

Then select the Plone Add-on template.

Project Generation Options

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

Option	Description	Example
addon_title	Your addon's human-readable name, capitals and spaces allowed.	Plone Blog
description	Describes your addon 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

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!