How to use the pip, mxdev, cookiecutter-zope-instance and make based install.
On the commandline, execute the make
command.
Without any options, make will run all steps.
make run
All options are printed with
make help
clean remove instance configuration (keeps data)
help This help message
install pip install all dependencies and scripts
instance create configuration for an zope (plone) instance
prepare prepare soures and dependencies
run run Plone
Order for make run
is: prepare, install, instance, run.
The Makefile is built to detect changes.
At the first make run
all steps are excuted.
Subsequent calls are only starting the applicaton server in the run step.
If one of the input file is changed, steps needed to take those changes into effect are executed again.\
The Makefile support different modes of Python:
- Create new virtualenv under
./venv
(default) from a global Python 3.python3
is expected to be in the PATH. - Like (1), but the
VENV_FOLDER
is passed to every make call:make VENV_FOLDER=./some_folder/ install
. make VENV=off install
: Direct usage of current configure Python 3 environment. Like if one uses pyenv or another already activated virtual environment, or in CI if the environment is alredy isolated.- Like (3), but the environment is not activated, so we need to point make to the location with
make VENV=off VENV_FOLDER=~/myenv/myproject_venv
or alike.
Attention: if those paramters are used, they must be passed to every make call!
Hint: Edit the Makefile
and look for VENV?=on
(which sets the default). And VENV_FOLDER?=
(look for the if before) and adjust to your needs.
Initially the files below were generated by plone-kickstarter
.
They are meant to be modified for your needs.
They aim to ease development and deployment of Plone 6+
constraints.txt
Version pins for your project, used by pip.
INSTALL.md
(this file)
instance.yaml
Zope/Plone application server configuration. Used by cookiecutter-zope-instance
Makefile
The configuration for make
requirement.txt
The core requirements.
sources.ini
mxdev is used to develop with sources from VCS like Git.
If you need sources from git, add them here.
The configuration here uses: