Skip to main content

PDF parsing for Singaporean banks

Project description

[!WARNING]
monopoly-sg has moved to monopoly-core on PyPI


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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: monopoly_sg-0.8.4.tar.gz
  • Upload date:
  • Size: 224.8 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.4.tar.gz
Algorithm Hash digest
SHA256 90e63fd0cf268eca82af017e1a0a93d4d92ad619e24bd14fb6a933235e141313
MD5 c4a82b62ec2c4930ba804757b1de8570
BLAKE2b-256 d9a1e404d7e82742494b9c1da3275d27cb24d4eb337f17d1febce088ca2b095f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: monopoly_sg-0.8.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 556106b2287b136fccc946e1cd26883a78cea2c7c0d6a2e4e51f0fac47ffd7a8
MD5 fb3fa54499c3c57ecc9c1414f5bf57d5
BLAKE2b-256 49706c0794c9b0cea52eb8b839509804acbccea2a116232964983d5771c0c47b

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