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.17.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.17.0-py3-none-any.whl (251.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for monopoly_core-0.17.0.tar.gz
Algorithm Hash digest
SHA256 a5adc4a3d85de3fcf66bd49d0cc617e3b7fcc92e72eb971e44753fa2bde9f1d4
MD5 f39c8fee28e2b58c07aea396d19b6939
BLAKE2b-256 a1cd4a8173be3033a7be79df972634dc752e3691d532d6edee164eb4156e1e4b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for monopoly_core-0.17.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5ee825e8d8d4a9041f7274c73826552129782367dae9843a17569cf535e07265
MD5 8fa0407a7faf5d648e9346ed44e20403
BLAKE2b-256 08c68db617a53ff31fde532fb1978667399419b54338115fae191726660e5cce

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