maybankpdf2json 0.1.53

A package for extracting JSON data from Maybank PDF account statements

maybankpdf2json

A small Python library to extract transaction data from Maybank PDF account statements.

Install

Requires Python 3.8 or newer.

pip install maybankpdf2json

Quick Start

from maybankpdf2json import MaybankPdf2Json

with open("statement.pdf", "rb") as f:
    extractor = MaybankPdf2Json(f, "your_pdf_password")

    # Raw Python data
    transactions = extractor.data()
    print(transactions[0])

    # Nicely formatted JSON string
    print(extractor.dumps())

    # Full output with account metadata
    print(extractor.dumps_v2())

API

MaybankPdf2Json(buffer, pwd)

• json() -> List[Output]
  • Returns transaction rows with fields: date, desc, trans, bal.
• data() -> List[Output]
  • Clearer alias for json().
• jsonV2() -> dict
  • Returns:
    • account_number: statement account number when available
    • statement_date: statement date in dd/mm/yy
    • transactions: same list as json()
• data_v2() -> dict
  • Clearer alias for jsonV2().
• dumps(indent=2) -> str
  • Returns transaction data as nicely formatted JSON text.
• dumps_v2(indent=2) -> str
  • Returns account metadata plus transactions as nicely formatted JSON text.

Output Notes

• Dates use dd/mm/yy.
• Amounts support trailing sign notation from statements:
  • 123.45- -> -123.45
  • 123.45+ -> 123.45

Example pretty-printed output:

Transaction list output from dumps():

[
  {
    "date": "01/09/24",
    "desc": "BEGINNING BALANCE",
    "trans": 0,
    "bal": 3285.77
  },
  {
    "date": "01/09/24",
    "desc": "TRANSFER FROM A/C MBBQR1714285 * 11111755387009 124998670Q",
    "trans": -10.0,
    "bal": 3275.77
  }
]

Full output from dumps_v2():

{
  "account_number": "162021-851156",
  "statement_date": "30/09/24",
  "transactions": [
    {
      "date": "01/09/24",
      "desc": "BEGINNING BALANCE",
      "trans": 0,
      "bal": 3285.77
    }
  ]
}

Development

Install project dependencies:

make install

Run tests:

make test

Alternative test command:

pytest tests/

See CONTRIBUTING.md for development workflow and docs/ARCHITECTURE.md for parser internals.

Release

See CHANGELOG.md for release history.

Automatic PyPI publishing is configured with GitHub Actions in .github/workflows/publish.yml.

One-time setup on PyPI:

1. Open the project on PyPI.
2. Add a Trusted Publisher for this GitHub repository.
3. Use workflow name publish.yml.
4. Use environment name pypi.

Release flow:

1. Move items from [Unreleased] in CHANGELOG.md into a new version section.
2. Update the version in pyproject.toml and setup.py.
3. Commit and push main.
4. Create and push a version tag such as v0.1.53.
5. GitHub Actions builds the package and publishes it to PyPI automatically.

Example:

git tag v0.1.53
git push origin v0.1.53

Local manual release remains available for maintainers:

make release

This builds and uploads to PyPI using Twine. Run only with valid release credentials.

License

MIT. See LICENSE.