An Open Banking CLI
Project description
💲 leggen
An Open Banking CLI.
This tool aims to provide a simple way to connect to banks using the GoCardless Open Banking API.
Having a simple CLI tool to connect to banks and list transactions can be very useful for developers and companies that need to access bank data.
Having your bank data in a database, gives you the power to backup, analyze and create reports with your data.
🛠️ Technologies
- GoCardless Open Banking API: for connecting to banks
📦 Storage
- SQLite: for storing transactions, simple and easy to use
- MongoDB: alternative store for transactions, good balance between performance and query capabilities
⏰ Scheduling
- Ofelia: for scheduling regular syncs with the database when using Docker
📊 Visualization
- NocoDB: for visualizing and querying transactions, a simple and easy to use interface for SQLite
✨ Features
- Connect to banks using GoCardless Open Banking API
- List all connected banks and their statuses
- List balances of all connected accounts
- List transactions for all connected accounts
- Sync all transactions with a SQLite and/or MongoDB database
- Visualize and query transactions using NocoDB
- Schedule regular syncs with the database using Ofelia
- Send notifications to Discord and/or Telegram when transactions match certain filters
🚀 Installation and Configuration
In order to use leggen
, you need to create a GoCardless account. GoCardless is a service that provides access to Open Banking APIs. You can create an account at https://gocardless.com/bank-account-data/.
After creating an account and getting your API keys, the best way is to use the compose file. Open the file and adapt it to your needs.
Example Configuration
Create a configuration file at with the following content:
[gocardless]
key = "your-api-key"
secret = "your-secret-key"
url = "https://bankaccountdata.gocardless.com/api/v2"
[database]
sqlite = true
mongodb = true
[database.mongodb]
uri = "mongodb://localhost:27017"
[notifications.discord]
webhook = "https://discord.com/api/webhooks/..."
[notifications.telegram]
# See gist for telegram instructions
# https://gist.github.com/nafiesl/4ad622f344cd1dc3bb1ecbe468ff9f8a
token = "12345:abcdefghijklmnopqrstuvxwyz"
chat-id = 12345
[filters.case-insensitive]
filter1 = "company-name"
Running Leggen with Docker
After adapting the compose file, run the following command:
$ docker compose up -d
The leggen container will exit, this is expected since you didn't connect any bank accounts yet.
Run the following command and follow the instructions:
$ docker compose run leggen bank add
To sync all transactions with the database, run the following command:
$ docker compose run leggen sync
👩🏫 Usage
$ leggen --help
Usage: leggen [OPTIONS] COMMAND [ARGS]...
Leggen: An Open Banking CLI
Options:
--version Show the version and exit.
-c, --config FILE Path to TOML configuration file
[env var: LEGGEN_CONFIG_FILE;
default: ~/.config/leggen/config.toml]
-h, --help Show this message and exit.
Command Groups:
bank Manage banks connections
Commands:
balances List balances of all connected accounts
status List all connected banks and their status
sync Sync all transactions with database
transactions List transactions
⚠️ Caveats
- This project is still in early development, breaking changes may occur.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file leggen-0.6.7-py3-none-any.whl
.
File metadata
- Download URL: leggen-0.6.7-py3-none-any.whl
- Upload date:
- Size: 19.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.5 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 48b0261513722f106a48547a029e3a0150dce4a30fa50208291bc3347c12280e |
|
MD5 | dc2ce6a338512653d9698badbcd613af |
|
BLAKE2b-256 | 564e48a1255c747d010dafbe1ffd916e082f826f95ccb492580265dd3be9fd8e |