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 apt & Homebrew

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

Uploaded Source

Built Distribution

monopoly_sg-0.5.0-py3-none-any.whl (191.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: monopoly_sg-0.5.0.tar.gz
  • Upload date:
  • Size: 185.9 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.5.0.tar.gz
Algorithm Hash digest
SHA256 3c319a24c36a213e3f29ad546909e8be4ed28b2a8e295a80a1ee45355683696c
MD5 0024130e89e19ef2d90d1b96327c583a
BLAKE2b-256 73f310579bbeca4696814b7eb1a8bb5e1c85902cfa957445d4c3bfd14e4ddf0a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: monopoly_sg-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 191.5 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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 823b1dd1065db80667d689470acdb789b9bde4ebfffe1b945cf765c1e9339e03
MD5 87d1d9c292f17059c382256465c12800
BLAKE2b-256 2cd058e8d3dfd9accac4a1ae4be9ec255be7f3ea8885bbdfe875b1eec2ce6960

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