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
Bank of Montreal (BMO)
Canadian Imperial Bank of Commerce (CIBC)
Canadian Tire Bank
Capital One Canada
Chase
Citibank
DBS/POSB
HSBC
Maybank
OCBC
Royal Bank of Canada (RBC)
Scotiabank
Standard Chartered
TD Canada Trust
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.1.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.1-py3-none-any.whl (262.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for monopoly_core-0.19.1.tar.gz
Algorithm Hash digest
SHA256 c6118e2c307e88cd0cc210e1e40426616aa97a075db53372730d39278871e0e1
MD5 68f0b63e7f3c10bcd0642811377eeb23
BLAKE2b-256 f918849c1952e727b0f06ab80892b0a59bd18835983f736925d781c72b90ac9e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for monopoly_core-0.19.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8e00e115732d8403e6b6d450ec801aaf8d9f2258e3de614b32bb0186ecc77bea
MD5 50baa14ba053f052fd895c1b1890baa1
BLAKE2b-256 e3312788e19acaa0c11f2c5ec7cf920d48d81d6ffef47f7920f2a0014302126e

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