Set up a development environment

Set up a development environment#

This guide walks you through setting up a local environment for working on the Cookieplone codebase.

Prerequisites#

  • Python 3.10 or later.

  • uv installed.

  • git installed.

Clone the repository#

git clone https://github.com/plone/cookieplone.git
cd cookieplone

Install dependencies#

make install

This creates a virtual environment and installs Cookieplone with all development dependencies using uv.

Run the test suite#

make test

All tests must pass before submitting a pull request.

Run the linters#

make lint

This runs ruff (format check and lint) and pyupgrade over the codebase. Fix any reported issues before submitting.

Run a single test file#

uv run pytest tests/path/to/test_file.py -v

Run a specific test#

uv run pytest tests/path/to/test_file.py::test_function_name -v

Build the documentation#

make docs-html

The output is written to docs/_build/html/.

Run Vale on the documentation#

make docs-vale

This lints the documentation for style issues using the Microsoft style guide.

Full documentation test#

make docs-test

This runs both the Sphinx build and Vale. All errors must be resolved before submitting documentation changes.

Contents