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

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.14.2.tar.gz (235.9 kB 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.14.2-py3-none-any.whl (251.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: monopoly_core-0.14.2.tar.gz
  • Upload date:
  • Size: 235.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.11 Linux/6.8.0-1021-azure

File hashes

Hashes for monopoly_core-0.14.2.tar.gz
Algorithm Hash digest
SHA256 da2a08a047025d13ad3c523b039210246d3236350465b6acc9bda6dcab6848e2
MD5 1ddb508e1d8f98eade548e86e84d801b
BLAKE2b-256 73ede2f5a635882682bec2e44accd082a6a911e152fc9ed797d2404826d97762

See more details on using hashes here.

File details

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

File metadata

  • Download URL: monopoly_core-0.14.2-py3-none-any.whl
  • Upload date:
  • Size: 251.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.11 Linux/6.8.0-1021-azure

File hashes

Hashes for monopoly_core-0.14.2-py3-none-any.whl
Algorithm Hash digest
SHA256 31ae1db67e16b9c0a75e6685e5dee48544c79fc734fc38dd5706653fc7d32b5c
MD5 deda0dad06bd0e92c95bebc8f2cf765b
BLAKE2b-256 a0acbe6db0c7be493d1c797a307e5c769fa4f36c522fce8819b69c139d8c22fd

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