cookiecutter-zope-instance

Cookiecutter template to create a full and complex configuration for a Zope 5 WSGI instance.

Key capabilities:

  • Creates zope.conf, zope.ini, site.zcml and initial user

  • Configures WSGI server (Waitress) settings

  • Supports four database backends: direct filestorage, RelStorage, ZEO, PGJsonb

  • CORS configuration for REST API usage

  • Development and profiling options

  • Environment-variable helper for containerized deployments

All non-ancient features of plone.recipe.zope2instance are provided plus new features.

Requirements: Python 3.10+, cookiecutter

Documentation

Tutorials

Learning-oriented – Step-by-step lessons to build skills.

Start here if you are new to cookiecutter-zope-instance.

Tutorials
How-To Guides

Goal-oriented – Solutions to specific problems.

Use these when you need to accomplish something.

How-to guides
Reference

Information-oriented – All configuration options documented.

Consult when you need detailed information.

Reference
Explanation

Understanding-oriented – Architecture and design decisions.

Read to deepen your understanding of how it works.

Explanation

Quick start

  1. Install cookiecutter: pip install cookiecutter

  2. Create an instance.yaml with your settings

  3. Run: cookiecutter -f --no-input --config-file instance.yaml gh:plone/cookiecutter-zope-instance

See Your first Zope instance for a complete walkthrough.