https://github.com/mtlynch/beancount-mercury

Beancount importer for Mercury Startup Checking
https://github.com/mtlynch/beancount-mercury

Last synced: 12 days ago
JSON representation

Beancount importer for Mercury Startup Checking

• Host: GitHub
• URL: https://github.com/mtlynch/beancount-mercury
• Owner: mtlynch
• License: mit
• Created: 2022-02-05T22:29:27.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-03T13:08:32.000Z (13 days ago)
• Last Synced: 2024-06-03T15:13:10.135Z (13 days ago)
• Language: Python
• Size: 152 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-beancount - Mercury

README

        
# beancount-mercury

[![PyPI](https://img.shields.io/pypi/v/beancount-mercury)](https://pypi.org/project/beancount-mercury/)

[![CircleCI](https://circleci.com/gh/mtlynch/beancount-mercury.svg?style=svg)](https://circleci.com/gh/mtlynch/beancount-mercury)

[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](LICENSE)

beancount-mercury provides an Importer for converting CSV exports Mercury checking transactions into [Beancount](https://github.com/beancount/beancount) v2 format.

## Installation

```bash

pip install beancount-mercury

```

## Usage

Add the Mercury importer to your account as follows:

```python

import beancount_mercury

CONFIG = [

    beancount_mercury.CheckingImporter(

        'Assets:Checking:Mercury',

        currency='USD',

        account_patterns=[

          # These are example patterns. You can add your own.

          ('GITHUB', 'Expenses:Cloud-Services:Source-Hosting:Github'),

          ('Fedex',  'Expenses:Postage:FedEx'),

        ]

    ),

]

```

The `account_patterns` parameter is a list of (regex, account) pairs. For each line in your Mercury CSV, `CheckingImporter` will attempt to create a matching posting on the transaction by matching the payee or narration to the regexes. The regexes are in priority order, with earlier patterns taking priority over later patterns.

Once this configuration is in place, you can use `bean-extract` to convert a Mercury CSV export of transactions to beancount format:

```bash

bean-extract config.py mercury-transactions.csv

```

## Resources

See [awesome-beancount](https://awesome-beancount.com/) for other publicly available Beancount importers.