Skip to content

Latest commit

 

History

History
180 lines (125 loc) · 5.06 KB

README.md

File metadata and controls

180 lines (125 loc) · 5.06 KB
Raw

Kickstarting Plone 6 (backend)

Bakes a configuration to start Plone 6 Backend using make, mxdev, pip, cookiecutter and WSGI.

This cookiecutter templates result helps in

  • building Plone or an add-on for Plone using pip, mxdev and a Makefile
  • running Plone (with add-on)
  • developing an add-on with above tools
  • launching and debugging Plone from within VisualCode

Prerequisites

  • cookiecutter

    pip install "cookiecutter==2.1.1"

  • (optional, for mode add-on) plonecli (and bobtemplates.plone (>= 6.0b10) if you want to create a plone customization or add-on.

    pip install plonecli "bobtemplates.plone>=6.0b10"

    Best is to install the two tools into your standard Python 3 (not the venv inside the project).

Options

project_name Name of the project or add-on. In mode standalone just the target folder name; in mode add-on the dotted name of the package.

mode - standalone (default): generate a build system for a Plone site, but folder does not directly contain a source package (like generated with plonecli). - addon: generate a integrated build for an add-on.

requirements-out mxdev is used to help with development with sources on top f stable constraints. It generates a pip requirements file. Configure here how the file is named. Default: requirements-mxdev.txt. admin_user cookiecutter-zope-instance is used to generate an instance configuration for the Plone/Zope application server. It creates an initial user with full access. This is the username. Default: admin. admin_user cookiecutter-zope-instance is used to generate an instance configuration for the Plone/Zope application server. It creates an initial user with full access. This is the password. If empty a password is generated. Default: empty. plone_version Plone Release to be used in the constraints file. Default: Should be most recent version, except short after a new release (PR's welcome). listen host:port for the WSGI server to listen on. Usually "localhost:8080" for local development or "0.0.0.0:8080" if the port needs to be accessible from the outside. Default: localhost:8080

These options can be stored in a plone-kickstarter.yaml:

    default_context:
        project_name: 'admin'
        mode: 'addon'
        admin_user: 'admin

Pass additional parameters --no-input --config-file plone-kickstarter.yaml. cookiecutter takes the stored values or the defaults and does not ask further questions.

Usage

    cookiecutter -f https://github.com/bluedynamics/plone-kickstarter

It supports two mode: standalone and add-on.

standalone creates a setup for a minimal vanilla Plone site. The setup can then be enhanced for your needs.

add-on is meant to add a the setup to a prior created plonecli code.

Create a vanilla Plone site

  • Ensure Python 3.9 is installed (including pip).
  • Run cookiecutter with option mode set to standalone.
  • Enter generated directory.
  • Run make run

Create a Plone add-on

TL/DR

pip install plonecli "bobtemplates.plone>=6.0b10" git+https://github.com/cookiecutter/cookiecutter.git#egg=cookiecutter
plonecli create add-on acme.foo
# (set Plone verson to 6.0.0a2, otherwise answer questions with defaults)
cookiecutter -f https://github.com/bluedynamics/plone-kickstarter.git
# (select add-on mode, otherwse defaults)
cd acme.foo
make run

Detailed

Install plonecli

pip install plonecli "bobtemplates.plone>=6.0b10"

First create your Plone project, let's call it "acme.foo" using plonecli and bobtemplates.plone:

    plonecli create add-on acme.foo

Answer all questions and use Plone latest Plone 6 (6.0.0a2 at the time of writing).

Then add the magic to the newly created project by applying this cookiecutter template:

    cookiecutter -f https://github.com/bluedynamics/plone-kickstarter

You have to answer the project package with the same name as the add-on name, so acme.foo in this case.

Run cookiecutter with option mode set to add-on.

For details on the usage of the Makefile read the generated file README_USAGE.md.

Enter the created project

    cd acme.foo

Use the Makefile

    make run

For details on the usage of the Makefile read the generated file README_USAGE.md.

Visual Studio Code support

Prerequisite

Install the official Microsoft Python plugin.

Usage in VSCode

  • Start VSCode in your projetc folder with

    code .

  • Select the python environment that you have used to build the project (your virtualenv).

  • When you click on the debug icon you can see up to two run configurations in the drop-down box at the top:

    • Python: Plone ($PROJECTNAME)
    • Python: Test Plone ($PROJECTNAME) (only in mode add-on)

With those you can run and test Plone, you can set breakpoints have access to the interactive debugger of VisualCode.

Have fun!

Contributors

  • Philipp Auersperg @zworkb
  • Jens Klein @jensens