rustledger-importer

Import framework for rustledger - extract transactions from bank files.

Overview

This crate provides infrastructure for extracting Beancount transactions from bank statements, credit card statements, and other financial documents. It follows the design of Python beancount's bean-extract.

Supported Formats

Example

use rustledger_importer::{ImporterConfig, extract_from_file};
use std::path::Path;

// Create a CSV importer configuration
let config = ImporterConfig::csv()
    .account("Assets:Bank:Checking")
    .currency("USD")
    .date_column("Date")
    .narration_column("Description")
    .amount_column("Amount")
    .build();

// Extract transactions from a file
let result = extract_from_file(Path::new("bank.csv"), &config)?;

for directive in result.directives {
    println!("{:?}", directive);
}

Enriched Imports

The enrichment pipeline adds intelligence on top of basic CSV/OFX extraction:

• Auto-inference of CSV format (delimiter, date format, column roles)
• Merchant dictionary for automatic account categorization
• Fingerprinting for dedup against existing ledger entries
• Confidence scores on every enrichment decision

use rustledger_importer::{auto_extract, CsvConfigBuilder};
use std::path::Path;

// Zero-config: auto-detect format and enrich
let result = auto_extract(Path::new("bank.csv"), "Assets:Bank:Checking")?;

for entry in &result.enriched {
    println!("{}: {} (confidence {:.0}%)",
        entry.directive, entry.category, entry.confidence * 100.0);
}

// Or opt-in to enrichment via the builder
let config = CsvConfigBuilder::new()
    .account("Assets:Bank:Checking")
    .currency("USD")
    .use_merchant_dict()
    .build();

Key Types

Importer Trait

Implement the Importer trait to add support for new file formats:

use rustledger_importer::{Importer, ImportResult};
use std::path::Path;
use anyhow::Result;

struct MyImporter;

impl Importer for MyImporter {
    fn name(&self) -> &str { "my-importer" }

    fn identify(&self, path: &Path) -> bool {
        path.extension().is_some_and(|e| e == "myext")
    }

    fn extract(&self, path: &Path) -> Result<ImportResult> {
        // Parse file and return directives
        Ok(ImportResult::empty())
    }
}

License

GPL-3.0