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.19.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.19.0-py3-none-any.whl (262.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for monopoly_core-0.19.0.tar.gz
Algorithm Hash digest
SHA256 90c61b3ad133f5673a08195f1b0c5878cdc9ca2f4ae7f7c3a5c0d010325c19b7
MD5 e6fa5eb5036f17f4864eca5a6eb91de0
BLAKE2b-256 fde3d123d2a3ffddbddd7f29fc5226d406f13f414bc5fcc387c5aa3fed21750d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for monopoly_core-0.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7b4281e45eb67fd21638bebd24816cc91a7d1a9b2cf3af4c15125cbda416e8a1
MD5 c326728de89b1ce2e9afcb084c86a51d
BLAKE2b-256 d15cbdf05ef6c8aa5dfc26ff8aa58a96719c53d829b1d4e874e5d83cfcee155f

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