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

Uploaded Source

Built Distribution

monopoly_sg-0.8.3-py3-none-any.whl (231.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for monopoly_sg-0.8.3.tar.gz
Algorithm Hash digest
SHA256 77cfac2f8e6ab657487e2e8be3687c113292e968c467993e5c34c2570f691735
MD5 5991fb1347fa60dd7b7789c84e73ea6d
BLAKE2b-256 7f90cc823c03e4ad772d3a80de983c08e59c711b366f4965c20ead59b986fa2f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for monopoly_sg-0.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 7adba298fc06e8561351c5aecb3f0c0e04d02019dcdbe6e79511cca5c811ea77
MD5 3af07d825ac26063c005d4ca9e3d1676
BLAKE2b-256 d22477a421bb4b6c0528528c4435053e5588745eb6fcefc9b5f6ffb7027c6884

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