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

Uploaded Source

Built Distribution

monopoly_sg-0.6.0-py3-none-any.whl (217.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: monopoly_sg-0.6.0.tar.gz
  • Upload date:
  • Size: 211.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.6 Linux/5.15.133.1-microsoft-standard-WSL2

File hashes

Hashes for monopoly_sg-0.6.0.tar.gz
Algorithm Hash digest
SHA256 8233da18eb3f00d10455da019c0761e2945fc9ffe425f00993a7c211118258c0
MD5 ff676d8d290860c47cdf08d1fa43bd6a
BLAKE2b-256 c30f8aff259a832c3582313a79a7b890e67998062c6f5be2a7892f66822a4c77

See more details on using hashes here.

File details

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

File metadata

  • Download URL: monopoly_sg-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 217.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.6 Linux/5.15.133.1-microsoft-standard-WSL2

File hashes

Hashes for monopoly_sg-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0b58a0fe636de96ec0465ef0bbfec31c3fb07175395ca729febc776f150e1d85
MD5 0c37f9df27e14e625333df0b40f45fcc
BLAKE2b-256 ecdeca3d4dc08df1ed7a93adae0e9aff03cbf9a4d8d9bb3f43460348370f9df6

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