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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for monopoly_core-0.13.6.tar.gz
Algorithm Hash digest
SHA256 098e5bb737383b4b230c8b742ed8e3953c966226e22f96d855af1fe635d25158
MD5 0442500d1322f5696ddae1e7a4a66994
BLAKE2b-256 1b641c3c5e4cdc76b0d54aba4bdeba05590a67d4dd3ddf275d62772c895e9ee8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: monopoly_core-0.13.6-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.11 Linux/6.5.0-1025-azure

File hashes

Hashes for monopoly_core-0.13.6-py3-none-any.whl
Algorithm Hash digest
SHA256 bb5624ff30c195abb55884c81bf5b573d1e7a8e04e483fdacf4ab6ddf950c884
MD5 c94ca23701c27d62debdac1fa5dbd720
BLAKE2b-256 166a1316aa85390727ac5b9e42bacd112f430a9a8846d4fc12a475acdafa2d21

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