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.4.tar.gz (212.2 kB view details)

Uploaded Source

Built Distribution

monopoly_sg-0.7.4-py3-none-any.whl (218.4 kB view details)

Uploaded Python 3

File details

Details for the file monopoly_sg-0.7.4.tar.gz.

File metadata

  • Download URL: monopoly_sg-0.7.4.tar.gz
  • Upload date:
  • Size: 212.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.1 Linux/5.15.146.1-microsoft-standard-WSL2

File hashes

Hashes for monopoly_sg-0.7.4.tar.gz
Algorithm Hash digest
SHA256 4f5fd21d12695c46ff1efd6f8bfb43d5203d50d719fb6b8bdeba3a13d0973828
MD5 a41c7d8dd9252637359c8d17c9b7d59a
BLAKE2b-256 a418fce67fcaaf3225c544d5d2803016945c285be32b43e5593defff61447096

See more details on using hashes here.

File details

Details for the file monopoly_sg-0.7.4-py3-none-any.whl.

File metadata

  • Download URL: monopoly_sg-0.7.4-py3-none-any.whl
  • Upload date:
  • Size: 218.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.1 Linux/5.15.146.1-microsoft-standard-WSL2

File hashes

Hashes for monopoly_sg-0.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5d34abd034708492ac6b2981db8e8066eab2e7dd41996a24e527994ac8cf3f4c
MD5 69133e7b141fdcc6d01342fa1bc48471
BLAKE2b-256 bd950135c807974d10ed846b54661cb2ad401dbb3c8ff4651dd3e5d73a40c26a

See more details on using hashes here.

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