Skip to main content

openbk

Documentation Status PyPI - Downloads

openbk is a small python library that can be used to read and extract transaction information from Moroccan bank statements (PDF).

Installation | Docs | Motivation

Features

  • Import an e-banking PDF statement and retrieve a clean DataFrame with transactions.
  • Get basic metrics (total debit, total credit, net movements).
  • Analyze bank transactions to extract their categories.
  • Analyze card payments (online and offline) to detect merchants.
  • Automatically detect which bank corresponds to the uploaded statement.

Supported Banks

  • ✅ CIH Bank (E-banking statements - Particuliers)
  • ✅ Attijariwafa Bank (E-banking statements - Particuliers)
  • 🔜 Banque Centrale Populaire (Coming Soon)

Other banks will be decided in the future

ℹ️ Transaction categories: I do not have a comprehensive list of transaction types, so I hope that the classification gets better with your contribution!

Dependencies and Installation

openbk relies on tabula-py to read and extract tables from PDFs. Tabula requires the following to function properly:

  • Python 3.10+
  • Java 8+

To add openbk to your project:

pip install openbk

Learn more about how to use openbk on our docs.

openbk can also be run through CLI commands.

Motivation

This project aims to simplify the task for developers who want to build apps that rely on the analysis of bank statements (Wallets, Lending, Consumer Behavior analysis, etc.). Ideally, openbk can help developers and data analysts in their financial scoring processes for applications in the Moroccan context.

Data Privacy

Please be careful when handling sensitive financial information and make sure to comply with the latest Moroccan data privacy laws and guidelines.

Metadata

Release files for openbk 1.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openbk 1.0.1
File Size Uploaded
openbk-1.0.1.tar.gz 19.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for openbk 1.0.1
File Interpreter ABI Platform
openbk-1.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 38.2 kB

Release files / openbk-1.0.1.tar.gz

Download URL openbk-1.0.1.tar.gz
Size 19.1 kB
Tags Source
SHA-256 checksum
How to use checksums
442184c33f838062fc2f6ca5413bbf02d7b192443a9d7ead1155f6d52a079c32
BLAKE2b-256 checksum
How to use checksums
0741db9aa936cdf2aa4b6b088630bd4c82ea8d0adeba8933d1ab650a4d321a33
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.2

Release files / openbk-1.0.1-py3-none-any.whl

Download URL openbk-1.0.1-py3-none-any.whl
Size 19.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6f6264f7d6bd5892d07477c5746cdf7b9c1d0d61f6b3557c629b6eb8b00cbcaf
BLAKE2b-256 checksum
How to use checksums
d412ada6779cd9f4b2e739f9b1162621fb7bd71efa1386813083ece77de05420
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.2

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

1.0.0

2 release files

0.0.2

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page