Introduction

Introduction

The Developer Cookbook is a collection of practical, high-impact recipes designed to help you extend, customize, and build on top of the OpenMind platform. If the Quickstart shows you how to use OM1, this Cookbook shows you how to build with it.

Here's what you can do with OM1

1. Build a new config file

2. Introduce a new mode

3. Configure a new Input Plugin

Before building with OM1, make sure you've completed the Getting Started guide and have OM1 installed. Understand the important concepts and components that are part of OM1.

Then dive into any recipe that interests you!

Development workflow

Linting and Testing (Mandatory)

To check/format/lint your code before committing, install pre-commit and execute pre-commit install. This ensures that pre-commit checks run before each commit.

Additionally, you can manually trigger all checks by running

pre-commit run --all-files

Unit Testing

To unit test the system, run:

uv run pytest --log-cli-level=DEBUG -s

Use type hints and docstrings for better code maintainability.