Skip to content

installation.mdx

Latest commit

 

History

History
77 lines (56 loc) · 1.74 KB

installation.mdx

File metadata and controls

77 lines (56 loc) · 1.74 KB
Raw
title Installation
description Get started with Marvin in under a minute
icon download

Requirements

  • Python 3.10 or higher
  • An API key from an LLM provider (OpenAI by default, or AI/ML API)

Install marvin

The easiest way to install Marvin is a package manager like pip or uv:

# add marvin to your project
uv add marvin
# add marvin to your virtual environment
uv pip install marvin
# add marvin to your script
uv add --script some_script.py marvin
# run a python process with marvin installed ephemerally
uv run --with marvin some_script.py
pip install marvin

Configure your LLM provider

By default, Marvin uses OpenAI's models. Set your API key as an environment variable:

export OPENAI_API_KEY="your-api-key"

To use AI/ML API, set the AIML_API_KEY variable instead:

export AIML_API_KEY="your-api-key"

To use another provider, see the docs on configuring LLMs.

Development Installation

For development, install Marvin with development dependencies:

git clone https://github.com/prefecthq/marvin.git
cd marvin
uv venv && source .venv/bin/activate
uv sync --dev
git clone https://github.com/prefecthq/marvin.git
cd marvin
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"

What's Next?

  • Follow the Quickstart guide to build your first AI application
  • Learn about Tasks, the building blocks of AI workflows
  • Explore Agents to create specialized AI workers
  • Read about Threads for managing conversation context