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.6rc0.tar.gz (212.6 kB view details)

Uploaded Source

Built Distribution

monopoly_sg-0.7.6rc0-py3-none-any.whl (218.9 kB view details)

Uploaded Python 3

File details

Details for the file monopoly_sg-0.7.6rc0.tar.gz.

File metadata

  • Download URL: monopoly_sg-0.7.6rc0.tar.gz
  • Upload date:
  • Size: 212.6 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.6rc0.tar.gz
Algorithm Hash digest
SHA256 abe50e9c269335296b1f35a9c6152634e42de898aa1cb881b2e71d88f44108ae
MD5 212ff534d9101ef8efbbebef15e7b964
BLAKE2b-256 0cd28e8477d64ae08c73ebdbdca1856d9ba0a9feaffc416500c56a3f42e20004

See more details on using hashes here.

File details

Details for the file monopoly_sg-0.7.6rc0-py3-none-any.whl.

File metadata

  • Download URL: monopoly_sg-0.7.6rc0-py3-none-any.whl
  • Upload date:
  • Size: 218.9 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.6rc0-py3-none-any.whl
Algorithm Hash digest
SHA256 446efb472db20050ea275373ca9f7a175ceadef6536c6ebc59dbc14f5711795a
MD5 5eef6117370ce0e416926d8c2b3b1029
BLAKE2b-256 3d6de74ab2b281952a26952cf05ee0a45cd2e715b054351fad8ca0961ac1d8f2

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