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
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.13.5.tar.gz (235.0 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.13.5-py3-none-any.whl (249.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: monopoly_core-0.13.5.tar.gz
  • Upload date:
  • Size: 235.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.10 Linux/6.5.0-1025-azure

File hashes

Hashes for monopoly_core-0.13.5.tar.gz
Algorithm Hash digest
SHA256 96e87b97a878e35370262b40259e57e0891bcea2e6ef77f9337760137034d842
MD5 e1bf66c8a29d5ce762202012631db020
BLAKE2b-256 97ffdf9a3a7d8fc87195c3ca6fd60ab854f8024c201ec1475a3589f2a9a595ce

See more details on using hashes here.

File details

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

File metadata

  • Download URL: monopoly_core-0.13.5-py3-none-any.whl
  • Upload date:
  • Size: 249.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.10 Linux/6.5.0-1025-azure

File hashes

Hashes for monopoly_core-0.13.5-py3-none-any.whl
Algorithm Hash digest
SHA256 be6140abbd518a04f21e44d1817b3bd9554176af64ad5574e3a06db107a7908f
MD5 4a0f518458b47467f0f00cdb0f1032fe
BLAKE2b-256 11168442827abf3691377ee1bf17daf1198f8d2397a7fe3c77a28b7a96bfdf7a

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