Development Guide

Prerequisites

Marvin requires Python 3.9+.

Installation

Clone a fork of the repository and install the dependencies:

git clone https://github.com/youFancyUserYou/marvin.git
cd marvin

Activate a virtual environment:

python -m venv .venv
source .venv/bin/activate

Install the dependencies in editable mode:

pip install -e ".[dev]"

Install the pre-commit hooks:

pre-commit install

Testing

Run the tests that don't require an LLM:

pytest -vv -m no_llm

Run all tests:

pytest -vv

Opening a Pull Request

Fork the repository and create a new branch:

git checkout -b my-branch

Make your changes and commit them:

git add . && git commit -m "My changes"

Push your changes to your fork:

git push origin my-branch

Open a pull request on GitHub - ping us on Discord if you need help!