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

Uploaded Python 3

File details

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

File metadata

  • Download URL: monopoly_core-0.14.0.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-1017-azure

File hashes

Hashes for monopoly_core-0.14.0.tar.gz
Algorithm Hash digest
SHA256 748e0a7c83dddf73fd232557231fe5398922354e463503a102a1367b7e9fbe8a
MD5 8b5ea3e0d887233bba6a243cbce8fc11
BLAKE2b-256 c5bbaaaca56c21a56aeb5e09a93a09ec4e10625e542843cce5c41143b9f4a49d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: monopoly_core-0.14.0-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-1017-azure

File hashes

Hashes for monopoly_core-0.14.0-py3-none-any.whl
Algorithm Hash digest
SHA256 25f3d7b41ff6fb43e6f43fd9dbeaeb0c7607af5add2aff41925ad168d2346a83
MD5 5a80b99c2575c4ef728a712624a03e56
BLAKE2b-256 e99f217ee3ec7a1c6870099899eed159cb39640eff51a210f869b02798b09db8

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