nikdoof/leggen
1
1
Fork 0
mirror of https://github.com/elisiariocouto/leggen.git synced 2025-12-13 13:42:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Improve README.md.

Browse Source
This commit is contained in:
Elisiário Couto
2024-02-19 00:53:56 +00:00
parent 91c74b0412
commit de17cf44ec
1 changed files with 18 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -1,22 +1,34 @@
# leggen # 💲 leggen
An Open Banking CLI. An Open Banking CLI.
## Features 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
- Python: for the CLI
- [GoCardless Open Banking API](https://developer.gocardless.com/bank-account-data/overview): for connecting to banks
- [MongoDB](https://www.mongodb.com/docs/): for storing transactions, good balance between performance and query capabilities
- [Ofelia](https://github.com/mcuadros/ofelia): for scheduling regular syncs with the database when using Docker
## ✨ Features
- Connect to banks using GoCardless Open Banking API - Connect to banks using GoCardless Open Banking API
- List all connected banks and their status - List all connected banks and their status
- List balances of all connected accounts - List balances of all connected accounts
- List transactions for an account - List transactions for an account
- Sync all transactions with a MongoDB database - Sync all transactions with a MongoDB database
## Installation and Configuration ## 🚀 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/. 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](docker-compose.yml). Open the file and adapt it to your needs. Then run the following command: After creating an account and getting your API keys, the best way is to use the [compose file](docker-compose.yml). Open the file and adapt it to your needs. Then run the following command:
```bash ```bash
$ docker-compose up -d $ docker compose up -d
``` ```
The leggen container will exit, this is expected. Now you can run the following command to create the configuration file: The leggen container will exit, this is expected. Now you can run the following command to create the configuration file:
@@ -37,7 +49,7 @@ To sync all transactions with the database, run the following command:
$ docker compose run leggen sync $ docker compose run leggen sync
``` ```
## Usage ## 👩‍🏫 Usage
``` ```
$ leggen --help $ leggen --help
@@ -60,5 +72,5 @@ Commands:
transactions List transactions for an account transactions List transactions for an account
``` ```
## Caveats ## ⚠️ Caveats
- This project is still in early development. - This project is still in early development.