Tutorial

This tutorial will walk you through the basics of using Karva.

Getting started

We will first create a new project using uv.

uv init --lib calculator

This will give us a project that looks like this:

calculator
├── pyproject.toml
├── README.md
└── src
    └── calculator
        ├── __init__.py
        └── py.typed

We can then create our core logic in src/calculator/__init__.py.

class Calculator:
    def add(self, a: int, b: int) -> int:
        return a + b

We can then create our tests in tests/test_add.py.

from calculator import Calculator

def test_add():
    calculator = Calculator()
    assert calculator.add(1, 2) == 3

Then, we'll add karva to our project.

uv add --dev karva

We can then run our tests with uv run karva test.

uv run karva test

This will give us a report of our tests.

All checks passed!