Skip to main content

PDF parsing for Singaporean banks

Project description


Streamlit Tests CI License: MIT

Monopoly is a Python library & CLI that converts Singapore bank statement PDFs to CSV.

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:

🎉 Monopoly is now live! 🎉

Try it out:
https://monopoly.streamlitapp.com/

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 with a script using the StatementHandler 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.8.1.tar.gz (224.7 kB view details)

Uploaded Source

Built Distribution

monopoly_sg-0.8.1-py3-none-any.whl (231.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for monopoly_sg-0.8.1.tar.gz
Algorithm Hash digest
SHA256 9f408c998ce521dc70f76eeca132187f85e77a5b4e152657ccc2b6e18a449fa1
MD5 9a9e6ff71a117d151c8f49ad2899a1c2
BLAKE2b-256 556c727f0415cd45b2e1fbf5c1b4b85af1c7c0e6159d166986b5b09f3e4dfda8

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for monopoly_sg-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a8c6f59d7b2293ceb278ff048d6777bad90b0d3fbf18b84865a569ff6761ed5d
MD5 5c9f2570511abb8f74b29b88a9a3b0ca
BLAKE2b-256 2dcc328f3ea96c7f3eca270764c81fb52fb5922a88770b7e6438615fb1f9295b

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