Copier template to create Plone/Zope setup

EXPERIMENTAL !!!

It supports storage backends standalone, ZEO and Relstorage and is using pyruvate as WSGI server. This template is meant to work standalone and inside an Plone addon.

Features

• support's 3 storage options: direct (standalone), ZEO, relstorage
• uses pyproject.toml and UV with hatchling build-backend
• is able to update existing setups when the template changes

More info about Copier to generate things from templates.

Usage

Install copier

If you don't have copier already installed, the easiest way is running this command:

uv tool install copier

This will install copier as a uv tool and you can run it directly.

Create project

In your project folder run:

copier copy gh:plone/copier-zope-setup . --trust

or if you don't one yet, run something like this:

copier copy gh:plone/copier-zope-setup my-project --trust

Install invoke

if you don't have invoke installed, the easiest way is running this command:

uv tool install invoke

Install or update dependencies

invoke install

Start Plone

invoke start

Update existing project

When ever the template has updates, you can update your generated project.

copier update --trust

or without the answering the questions again:

copier update --defaults --trust

You can also add https://github.com/MrTango/pdmplone to trusted locations in Copier settings file and run the commands without the --trust parameter.

https://copier.readthedocs.io/en/stable/settings/#trusted-locations

Example Copier settings file

On Linux:

mkdir ~/.config/copier
touch ~/.config/copier/settings.yml

Note: for the default to work, the question has to have a default parameter set!

defaults:
  user_name: "MrTango"
  user_email: [email protected]
  github_user: "MrTango"
  gitlab_user: "MrTango78"
  mastodon_handle: "https://mastodon.social/@mrtango"
  dbuser: "plonerel"
trust:
  - https://github.com/plone/
  - gh:plone/