Skip to content

Getting Started

Prerequisites

Python 3.9, 3.10, 3.11 or 3.12.

All of these versions are tested via CI/CD. Due to use of removeprefix(), not compatible with previous versions of Python.

Installation

First, update pip:

pip install -U pip

Then install:

pip install beancount-multitool

Try it out!

Let's see if installation was successful:

bean-mt --help
Usage: bean-mt [OPTIONS] NAME CONFIG DATA

  Read financial data and output a Beancount file.

  NAME is the name of the financial institution. See Note below for a list of
  supported names.

  CONFIG is a .toml file with run-time configurations, e.g. config.toml.

  DATA is the raw financial data downloaded from NAME, e.g. input.csv.

Options:
  --output PATH  Resulting Beancount file
  --version      Show the version and exit.
  --help         Show this message and exit.

  Note: supported financial institutions are ['ja_bank', 'rakuten_bank',
  'rakuten_card', 'shinsei_bank', 'sumishin_net_bank']