Interactive beanquery manual

• Interactive beanquery manual
  • 1 How to open the manual
    • 1.1 As a static HTML file
    • 1.1 To interact with the document, whilst reading
      • 1.1.1 Option 1: From the Marimo Molab cloud
      • 1.1.2 Option 2: Locally on your PC
  • 2 How to read the manual

This is an interactive manual and tutorial for beanquery — a customizable, extensible, lightweight SQL-like query tool for Beancount ledger data.

This document is intended as a follow-up to the Beancount v2 Beancount Query Language document.

It was created with the following goals in mind:

• to cover the latest features of beanquery
• to include many real examples using actual ledgers
• to be self-documenting: all query outputs are computed by running beanquery as part of the notebook execution
• to be interactive: when run as a marimo notebook, readers can experiment by changing the default ledgers and/or queries, with outputs updating automatically

Current state: work is ongoing. Comments, feedback and PRs are more than welcome!

1 How to open the manual

1.1 As a static HTML file

As a static HTML file the manual can be read at the GitHub Pages

1.1 To interact with the document, whilst reading

1.1.1 Option 1: From the Marimo Molab cloud

1.1.2 Option 2: Locally on your PC

To be able to interact with the manual (to change queries, ledgers) one has to run it as a marimo notebook. To achieve this do the following:

1. If not done yet, install uv for your OS, following the official instructions

2. Clone this directory:

   git clone https://github.com/Ev2geny/beanquery-interactive-manual.git
   
   cd beanquery-interactive-manual
   

3. Run the notebook in the view only mode:

   uv run marimo run manual.py
   

2 How to read the manual

Use the popping Table of Content on the right side to navigate the document