Skip to main content

Beangulp importer for SimpleFIN

Project description

Beangulp SimpleFIN Importer

PyPI version Python versions CI License: MIT

A beangulp importer for SimpleFIN data.

Installation

uv add beangulp-simplefin

Or with pip:

pip install beangulp-simplefin

Usage

1. Download SimpleFIN data

Use the SimpleFIN CLI to download your account data:

uv add simplefin
simplefin fetch --output ~/simplefin-data/

This creates one JSON file per account in the output directory.

2. Configure your importer

Create an import.py configuration:

from beangulp_simplefin import SimpleFINImporter
import beangulp

importers = [
    SimpleFINImporter(account_mapping={
        "ACT-xxx-xxx": "Assets:Checking:Chase",
        "ACT-yyy-yyy": "Assets:Checking:Schwab",
        "ACT-zzz-zzz": "Liabilities:CreditCard:Amex",
    })
]

if __name__ == "__main__":
    beangulp.Ingest(importers)()

3. Extract transactions

python import.py extract ~/simplefin-data/ >> ledger.beancount

4. Archive the files (optional)

python import.py archive ~/simplefin-data/ -o documents/

Importer Options

SimpleFINImporter(
    account_mapping,        # Dict mapping SimpleFIN account IDs to Beancount accounts
    currency='USD',         # Default currency
    expense_account='Expenses:Uncategorized',   # For outflows
    income_account='Income:Uncategorized',      # For inflows
)

Output Format

Each transaction becomes a Beancount entry:

2024-01-15 * "GROCERY STORE #123"
  simplefin_id: "TRN-abc123"
  Assets:Checking:Chase  -45.67 USD
    simplefin_id: "TRN-abc123"
  Expenses:Uncategorized

2024-01-16 balance Assets:Checking:Chase  1234.56 USD

Workflow Example

# Daily/weekly sync
simplefin fetch --output ~/simplefin-data/
python import.py extract ~/simplefin-data/ >> ledger.beancount
bean-check ledger.beancount

Related Tools

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

beangulp_simplefin-0.2.0.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

beangulp_simplefin-0.2.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file beangulp_simplefin-0.2.0.tar.gz.

File metadata

  • Download URL: beangulp_simplefin-0.2.0.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for beangulp_simplefin-0.2.0.tar.gz
Algorithm Hash digest
SHA256 5918941881bd637c21afc74613717d7bd0b6df282bcff000519ec074bc3a1da3
MD5 dcb8b39117164044d00f080561b66688
BLAKE2b-256 3351e3e2c1d9a3b5f4d5216966600a37dcfd60cf27a9864ba6edebe65969ed09

See more details on using hashes here.

Provenance

The following attestation bundles were made for beangulp_simplefin-0.2.0.tar.gz:

Publisher: publish.yml on robcohen/beangulp-simplefin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file beangulp_simplefin-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for beangulp_simplefin-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd01390c0b94e2a0b01a780f6ae87f7b10bc04168b30ea640366f3f973503aeb
MD5 3b0276285014188e1ce556a440799c3e
BLAKE2b-256 41dc157a20a061ffd3ab413d856864ec2a0d86c73c08a0acbc3e08c8a4d6b7b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for beangulp_simplefin-0.2.0-py3-none-any.whl:

Publisher: publish.yml on robcohen/beangulp-simplefin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page