Obsidian Base Engine

BaseRenderer API

from base_renderer import BaseRenderer

renderer = BaseRenderer(
    base_name="people",
    kind_field="person_kind",
    folder_glob="People/**/*.md",
    formulas={...},
    properties={...},
    views=[...],
)

# Render to a .base file
renderer.render(output_path="/vault/People.base")

# Validate a rendered base
issues = renderer.validate()

Formula Parser

The formula parser handles Dataview-style expressions used in Base files:

from formula_parser import FormulaParser

parser = FormulaParser()
result = parser.parse('if(primary_muscle, primary_muscle.toString().replace("[[", "").replace("]]", ""), "")')

View Composition

Build views from multiple note collections:

from base_renderer import compose_views

views = compose_views(
    [
        ("exercise", exercise_views),
        ("brokerage", brokerage_views),
    ],
    shared_properties=["file.name", "file.path", "modified"],
)

SKILL.md Integration

Kind-manager skills that use this engine document it in their SKILL.md:

## Base Rendering

This skill uses `obsidian-base-engine` for rendering.

Base files are generated by:

    uvx --from python --with pydantic --with pyyaml python \
      .skills/obsidian-base-engine/scripts/base_renderer.py \
      --base people --output People.base

Workflow: Adding a New Base Type

1. Add the new base type to BASE_REGISTRY in base_renderer.py
2. Define formulas, properties, and views
3. Run base_renderer.py --base <name> --output <path>
4. Add tests in tests/test_base_engine.py

Dependencies

• pydantic >= 2.0
• pyyaml
• Python 3.11+

References

• references/base-engine-api.md — detailed API documentation
• references/base-types.md — all supported base types and their schemas