marimo + uv Starter Template

A starter template for marimo notebooks using uv for dependency and project management. This template provides a modern Python development setup with best practices for notebook development.

Features

• 🚀 Python 3.12+ support
• 📦 Fast dependency management with uv
• 🧪 Testing setup with pytest
• 🎯 Code quality with Ruff (linting + formatting)
• 👷 CI/CD with GitHub Actions
• 📓 Interactive notebook development with marimo

Prerequisites

• Python 3.12 or higher
• uv installed

Getting Started

1. Clone this repository:

   git clone https://github.com/yourusername/marimo-uv-starter-template
   cd marimo-uv-starter-template

2. Run the marimo editor:

   uv run marimo edit

Development

Running Tests

# Run testing in your regular python files
uv run pytest tests
# Running testing in your marimo notebooks
uv run pytest src

Linting and formatting

uv run ruff check .
uv run ruff format .

Project Structure

├── .github/            # GitHub Actions workflows
├── src/               # Source code
│   └── app.py        # Sample marimo notebook
├── tests/            # Test files
├── pyproject.toml    # Project configuration
└── uv.lock           # Dependency lock file

License

MIT