Skip to main content

PDF parsing for Singaporean banks

Project description


Tests CI Code style: black Linting: pylint License: MIT

Monopoly is a Python library that converts Singapore bank statement PDFs to CSV using pdftotext

Supported banks:

Bank Credit Statement Debit Statement
Citibank :white_check_mark: :x:
DBS :white_check_mark: :white_check_mark:
HSBC :white_check_mark: :x:
OCBC :white_check_mark: :white_check_mark:
Standard Chartered :white_check_mark: :x:

Install

Clone the repo

git clone https://github.com/benjamin-awd/monopoly.git

Install dependencies using Homebrew

brew install make
make setup

Usage

Monopoly can be run as a Python package, allowing you to extract, transform and write bank statements to a CSV file.

To see how Monopoly works, you can run this example

python3 src/monopoly/examples/single_statement.py

If you need to run monopoly on a password protected file, ensure that passwords are set in the .env file:

cp .env.template env

If you have multiple statements from the same bank with different passwords (e.g. HSBC statements), make sure to set both passwords in an array format like so:

HSBC_PDF_PASSWORDS=["password1","password2"]

Features

  • Unlocks PDFs using user-provided credentials
  • Statements can be parsed with the CLI, or manually with the bank processor class.
  • Support for cashback transactions and refunds
  • Monopoly can be run on Google Cloud as a scheduled Cloud Run job, which opens up more sophisticated use-cases like historical analysis and personal finance visualization

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

monopoly_sg-0.7.8.tar.gz (212.5 kB view hashes)

Uploaded Source

Built Distribution

monopoly_sg-0.7.8-py3-none-any.whl (218.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page