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.18.4.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.18.4-py3-none-any.whl (253.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for monopoly_core-0.18.4.tar.gz
Algorithm Hash digest
SHA256 639a129d3e935f02c4bee38d5cc6f60278a9dc7c14cac0ba9377ea3cb6c68391
MD5 a8a99fea3876da26908a01a2f94209c7
BLAKE2b-256 54b4289fc609d1d3c75aad17ebfe4e005a87a1b3d8fbab6236fb2120a8df8c3b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for monopoly_core-0.18.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c331cb808c48b1e51ceda22e50e6093d07951aba4e0ecf34471176a9b87e5923
MD5 630d6343088486b089015907d77813d2
BLAKE2b-256 ba0a3a6290e9b4fc07daa4e4128f5daead5be7dd2e8bbd6ff08892dfb459b0f3

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