Skip to main content

Monopoly is a Python library & CLI that converts bank statement PDFs to CSV

Project description


Streamlit Tests CI License: AGPL 3.0

Monopoly is a Python library & CLI that converts bank statement PDFs to CSV.

Supported banks:

Bank Credit Statement Debit Statement
Bank of America
Chase
Citibank
DBS/POSB
HSBC
Maybank
OCBC
Standard Chartered
Trust
UOB
Zürcher Kantonalbank

Install

Monopoly is a pip-installable Python package on PyPI under the name monopoly-core.

Since Monopoly uses pdftotext, you'll need to install additional dependencies:

apt-get install build-essential libpoppler-cpp-dev pkg-config ocrmypdf

or

brew install gcc@11 pkg-config poppler ocrmypdf

Then install with pipx:

pipx install monopoly-core

For additional OCR support:

pipx install 'monopoly-core[ocr]'

Usage

Monopoly runs in your terminal, allowing you to extract, transform and write bank statements to a CSV file.

To list commands and options:

monopoly --help

You can run it on a single statement

monopoly src/monopoly/examples/example_statement.pdf

or multiple statements

monopoly ./statements

If you need to run monopoly on a password protected file, ensure that passwords are set in the .env file:

cp .env.template .env
PDF_PASSWORDS=["password1","password2"]

Monopoly can also be run as a Python library:

python3 src/monopoly/examples/single_statement.py

Features

  • Parses PDFs using predefined configuration classes per bank.
  • Handles locked PDFs with credentials passed via environment variables.
  • Supports adding OCR for image-based bank statements.
  • Provides a generic parser that can be used without any predefined configuration (caveat emptor).
  • Includes a safety check (enabled by default) that validates totals for debit or credit statements.

Development

Clone the repo

git clone https://github.com/benjamin-awd/monopoly.git

Install dependencies using Homebrew

brew install make
make setup
brew bundle

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

monopoly_core-0.16.0.tar.gz (3.8 MB view details)

Uploaded Source

Built Distribution

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

monopoly_core-0.16.0-py3-none-any.whl (250.7 kB view details)

Uploaded Python 3

File details

Details for the file monopoly_core-0.16.0.tar.gz.

File metadata

  • Download URL: monopoly_core-0.16.0.tar.gz
  • Upload date:
  • Size: 3.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.9

File hashes

Hashes for monopoly_core-0.16.0.tar.gz
Algorithm Hash digest
SHA256 b1f1e87bced95414fce3b631905436f7f6f064a43cbab661fa2a02db99a2edab
MD5 f76c252b69b9346c40737277c039934f
BLAKE2b-256 02c8cf5a80c73d312a4ada2a9555d7c9d4a4894dcaaad7e5949454cb70b34e25

See more details on using hashes here.

File details

Details for the file monopoly_core-0.16.0-py3-none-any.whl.

File metadata

File hashes

Hashes for monopoly_core-0.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1a4b1a0538342e9c6da4040f1578867843e9ebaf6bcb0c5f5f40dbd9ecc78135
MD5 d4d824d8df6f7d4ab25d61c033be2aab
BLAKE2b-256 4760a2d2e042c45e7b4f74d89615eeeeebb69b44d7e08a77dc9c5792aa46fc95

See more details on using hashes here.

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