Початок роботи

Вимоги

• Python 3.10–3.14
• Доступ до терміналу (macOS, Linux або WSL)

Встановлення

# Базове встановлення (тільки детерміністичні парсери)
pip install bankstatementparser

Додаткові модулі для розширених можливостей:

# Text-LLM path for digital PDFs (litellm + pypdf)
pip install ‘bankstatementparser[hybrid]’

# Higher-fidelity table extraction (adds pdfplumber)
pip install ‘bankstatementparser[hybrid-plus]’

# Vision-LLM path for scanned PDFs (adds pypdfium2)
pip install ‘bankstatementparser[hybrid-vision]’

# LLM-powered transaction categorisation
pip install ‘bankstatementparser[enrichment]’

# REST API microservice (FastAPI + uvicorn)
pip install ‘bankstatementparser[api]’

# Optional Polars DataFrame support
pip install ‘bankstatementparser[polars]’

Швидкий старт

Автовизначення та аналіз будь-якого структурованого формату

from bankstatementparser import create_parser, detect_statement_format

fmt = detect_statement_format("transactions.ofx")
parser = create_parser("transactions.ofx", fmt)
df = parser.parse()  # pandas DataFrame
print(df.head())

Це працює з файлами .xml (CAMT/PAIN.001), .csv, .ofx, .qfx, .mt940 та .sta.

Аналіз CAMT.053

from bankstatementparser import CamtParser

parser = CamtParser("statement.xml")
transactions = parser.parse()

Аналіз PAIN.001

from bankstatementparser import Pain001Parser

parser = Pain001Parser("payment.xml")
payments = parser.parse()

Аналіз PDF банківських виписок (гібридний pipeline)

Гібридний pipeline інтелектуально маршрутизує PDF через три шляхи витягування:

from bankstatementparser.hybrid import smart_ingest

result = smart_ingest("statement.pdf")
print(result.source_method)         # "deterministic" | "llm" | "vision"
print(result.verification.status)   # VERIFIED | DISCREPANCY | FAILED
print(result.transactions)          # List of extracted transactions

Кожне витягування перевіряється Золотим правилом: opening + credits − debits == closing.

Streaming великих файлів

Для файлів із тисячами транзакцій використовуйте streaming для обмеження пам’яті:

parser = CamtParser("large_statement.xml")
for transaction in parser.parse_streaming(redact_pii=True):
    process(transaction)  # Memory stays constant

Аналіз у пам’яті

Аналіз із байтів без дискового введення-виведення — зручно для SFTP або API:

xml_bytes = download_from_sftp()
parser = CamtParser.from_bytes(xml_bytes, source_name="daily.xml")
transactions = parser.parse()

Паралельна обробка файлів

Аналізуйте кілька файлів одночасно:

from bankstatementparser import parse_files_parallel

results = parse_files_parallel([
    "statements/jan.xml",
    "statements/feb.xml",
    "statements/mar.xml",
])
for r in results:
    print(r.path, r.status, len(r.transactions), "rows")

Масове сканування каталогів

Обробка цілих дерев каталогів з автоматичною дедуплікацією:

from bankstatementparser.hybrid import scan_and_ingest

batch = scan_and_ingest("statements/2026/", pattern="**/*.pdf")
print(f"Processed: {len(batch.results)} files")
print(f"Unique transactions: {batch.unique_count}")

Дедуплікація

Ідемпотентні hash транзакцій для безпечного інкрементального завантаження:

from bankstatementparser import CamtParser, Deduplicator

parser = CamtParser("statement.xml")
dedup = Deduplicator()
result = dedup.deduplicate(dedup.from_dataframe(parser.parse()))

print(f"Unique: {len(result.unique_transactions)}")
print(f"Exact duplicates: {len(result.exact_duplicates)}")
print(f"Suspected matches: {len(result.suspected_matches)}")

Категоризація транзакцій (збагачення)

Автоматична категоризація транзакцій за допомогою LLM:

from bankstatementparser.enrichment import Categorizer

categorizer = Categorizer()
enriched = categorizer.categorize_batch(transactions)
for txn in enriched:
    print(f"{txn.description}: {txn.category}")

Експорт у бухгалтерію (hledger / beancount)

Експорт транзакцій у формати plaintext-accounting:

from bankstatementparser.export import to_hledger, to_beancount

journal = to_hledger(transactions, account="Assets:Bank:Checking")
beancount_journal = to_beancount(transactions, account="Assets:Bank:Checking")

Мультивалютна перевірка балансу

Перевірка балансу незалежно для кожної групи валют:

from bankstatementparser.hybrid import verify_balance_multi_currency

results = verify_balance_multi_currency(transactions)
for currency, verification in results.items():
    print(f"{currency}: {verification.status}")

REST API

Розгортання як мікросервіс FastAPI:

# Start the API server
bankstatementparser-api --port 8000

# For container deployments
bankstatementparser-api --host 0.0.0.0 --port 9000

Ендпоінти:

• POST /ingest -- Аналіз файлу банківської виписки
• GET /health -- Перевірка стану

Безпечна обробка ZIP

Обробка заархівованих XML-файлів із вбудованими перевірками безпеки (захист від бомб, відхилення зашифрованих записів):

from bankstatementparser import iter_secure_xml_entries, CamtParser

for entry in iter_secure_xml_entries("statements.zip"):
    parser = CamtParser.from_bytes(entry.xml_bytes, source_name=entry.source_name)
    print(f"{entry.source_name}: {len(parser.parse())} transactions")

Експорт

parser = CamtParser("statement.xml")
parser.export_csv("output.csv")
parser.export_json("output.json")

# Polars (requires bankstatementparser[polars])
polars_df = parser.to_polars()

# Excel
parser.camt_to_excel("output.xlsx")

Використання CLI

# Parse structured formats
bankstatementparser --type camt --input statement.xml
bankstatementparser --type pain001 --input payment.xml

# Hybrid PDF pipeline
bankstatementparser --type ingest --input statement.pdf
bankstatementparser --type ingest --input statement.pdf --output ledger.csv

# Interactive review mode
bankstatementparser --type review --input result.json
bankstatementparser --type review --input result.json --output reviewed.json

# Export to CSV with streaming
bankstatementparser --type camt --input statement.xml --output transactions.csv
bankstatementparser --type camt --input statement.xml --streaming --show-pii

Параметри CLI:

• --type {camt,pain001,ingest,review} -- тип парсера або режим
• --input <path> -- вхідний файл
• --output <path> -- файл експорту (CSV або JSON)
• --streaming -- streaming великих файлів
• --show-pii -- показати конфіденційні поля (приховані за замовчуванням)
• --max-size <MB> -- обмеження розміру файлу

Налаштування локальної розробки

git clone https://github.com/sebastienrousseau/bankstatementparser.git
cd bankstatementparser
python3 -m venv .venv && source .venv/bin/activate
pip install poetry && poetry install --with dev
make install-hooks   # pre-commit hook runs `make verify` before every commit

Запуск тестів:

pytest

Довідник API

Класи парсерів

Допоміжні функції

Функція	Призначення
detect_statement_format(path)	Автовизначення формату файлу
create_parser(path, fmt)	Створення відповідного парсера
parse_files_parallel(paths)	Паралельний аналіз кількох файлів
iter_secure_xml_entries(zip_path)	Безпечна ітерація записів ZIP
smart_ingest(path)	Гібридне витягування з PDF з перевіркою
scan_and_ingest(dir, pattern)	Масове сканування каталогів
verify_balance_multi_currency(txns)	Перевірка балансу за валютою
to_hledger(txns, account)	Експорт у формат hledger
to_beancount(txns, account)	Експорт у формат beancount

Класи даних

Клас	Призначення
Deduplicator	Виявлення дублікатів транзакцій
DeduplicationResult	Результат з унікальними, точними та ймовірними збігами
InputValidator	Валідація шляхів та форматів файлів
Transaction	Нормалізований запис транзакції
FileResult	Результат паралельного аналізу
ZipXMLSource	Обгортка запису ZIP
IngestResult	Результат гібридного pipeline з перевіркою
VerificationResult	Результат перевірки балансу
Categorizer	Категоризація транзакцій за допомогою LLM
AccountMapper	Правила маппінгу рахунків на основі regex

Винятки

Виняток	Коли виникає
ParserError	Помилки аналізу
ExportError	Помилки експорту (CSV/JSON/Excel)
ValidationError	Помилки валідації вхідних даних
ZipSecurityError	Помилки перевірки безпеки ZIP