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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: monopoly_sg-0.8.2.tar.gz
  • Upload date:
  • Size: 224.9 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.2.tar.gz
Algorithm Hash digest
SHA256 b442ab5995ebca7e97552954b53666fb7c4699126a7cadbe68dfd6d545c446b7
MD5 07f20895c0857eacec8613bf243401d5
BLAKE2b-256 1766bf510e408a8c3ee8657710c65e059cba0d3799033d59c4844447c8b22aa5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: monopoly_sg-0.8.2-py3-none-any.whl
  • Upload date:
  • Size: 231.6 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8307e9832ead052914981e375fa764b6d4d71dd6d72df99a62a1151930cf1e4a
MD5 a3ca569db199d5fa8f54c70be1f4bb6b
BLAKE2b-256 1af1657f4d22fcfddae6ea602504b8d2daf4bcb45747f5e6281f07d1bce0a0e2

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