protobean

Protobuf schemas for Beancount ledgers, plus generated Dart and Python packages (protobean) that bind those messages.

The schemas cover a parsed ledger (parser output, including elided amounts and parse-time cost specs) and a processed ledger (booked, interpolated, and consistency-checked).

Protobuf

Sources live under proto/beancount/. Lint and format with Buf 1.72.0 (see buf.yaml):

buf lint
buf format --diff --exit-code

Dart package

Generated code is not committed. After fvm use (or otherwise putting Dart on PATH) and installing Buf:

./tool/generate_dart.sh
dart pub get
dart analyze --fatal-infos

import 'package:protobean/protobean.dart';

The Dart SDK is pinned via FVM in .fvmrc.

Python package

Generated code is not committed. After installing uv and Buf:

./tool/generate_python.sh
uv sync --group dev
uv run ruff check
uv run ruff format --check

from protobean import ledger_pb2

The Python version is pinned in .python-version.

Contributing

Commits follow Conventional Commits and should be atomic (one concern each). Local hooks are in .pre-commit-config.yaml.

Every pull request either adds one changelog line under ## [Unreleased] in CHANGELOG.md, or cuts a release.

An entry line is the squash-merge subject (the PR title) and the PR number:

- feat(proto): add processed ledger messages (#12)

Put that line in its own commit that only touches CHANGELOG.md. Open the PR first so you have a number, then add the changelog commit.

A release PR bumps the version in both pubspec.yaml and pyproject.toml and moves every Unreleased bullet under ## [<version>] - YYYY-MM-DD, leaving Unreleased empty. Publishing a v* tag fails unless Unreleased is empty.

CI runs ./tool/check-changelog.sh and rejects PRs that skip this.

License

GPL-3.0