CLI Tool for the Prometeo Open Banking API
Project description
prometeo-cli
CLI Tool for communicating to banking institutions through Prometeo Open Banking API.
Setup
The CLI allows you to configure multiple institution's accounts and environments depending if you are working with production
, testing
or sandbox
.
- First of all set the environment variable
PROMETEO_ENVIRONMENT
with your working environment - Install the requirements with
pip install -r requirements.txt
- Run it with
python -m pmo COMMAND [ARGS]
When running it, the script will check if the directory ~/.prometeo/
and the file ~/.prometeorc
exists.
The ~/.prometeorc
file stores the api session key.
The ~/.prometeo/
directory stores two configurations files:
configuration.ini
stores the different environments' cnfigurationcredentials.ini
stores the credentials of the institutions (The passwords are encrypted :stuck_out_tongue_winking_eye:)
Available commands
config [OPTIONS]
There are two options: --credential
for configuring a new set of credentials, and the --environment
for a new env.
The environment must match with the one you setted previously in the PROMETEO_ENVIRONMENT
variable.
login [OPTIONS]
Used for starting a new session
Options:
--provider
specifies the set of credentials to user (You can set a default provider with thePROMETEO_PROVIDER
environment variable)--interactive
to login interactively :smiley:
logout
Terminates the current session
accounts
Lists your banking accounts' details
cards
List your credit cards' details
movements [OPTIONS]
Lists your movements
Options All the options are required
(-a, --account) or (-c --card)
sets the origin of the movements(-cu, --currency)
As the credit cards movements might be in different currency you must specify one in ISO 4217--start-date
sets the start of the range of the movements to get in%Y-%m-%d
format--end-date
sets the end of the range of the movements to get in%Y-%m-%d
format
providers
Lists the available providers and their information (id, country and name) prometeo-cli
CLI Tool for communicating to bankings institutions through Prometeo Open Banking API.
Setup
The CLI allows you to configure multiple institutions accounts and environments depending if you are working with production
, testing
or sandbox
.
- First of all set the environment variable
PROMETEO_ENVIRONMENT
with your working environment - Run it with
python -m pmo COMMAND [ARGS]
When running it the script will check if the directory ~/.prometeo/
and the file ~/.prometeorc
exists.
The ~/.prometeorc
file stores the api session key.
In the ~/.prometeo/
directory stores two configurations files:
configuration.ini
stores the different environments configurationcredentials.ini
stores the credentials of the institutions (The passwords are encrypted :stuck_out_tongue_winking_eye:)
Available commands
config [OPTIONS]
There are two options --credential
for configuring a new set of credentials, and the --environment
for a new env.
login [OPTIONS]
Used for starting a new session
Options:
--provider
specifies the set of credentials to user (You can set a default provider with thePROMETEO_PROVIDER
environment variable)--interactive
to login interactively :smiley:
logout Terminates the current session
accounts Lists your banking accounts details
cards List your credit cars details
movements [OPTIONS] Lists your movements
Options All the options are required
(-a, --account) or (-c --card)
sets the origin of the movements(-cu, --currency)
As the credit cards movements might be in different currency you must specify one in ISO 4217--start-date
sets the start of the range of the movements to get in%Y-%m-%d
format--end-date
sets the end of the range of the movements to get in%Y-%m-%d
format
providers List the available providers and their information (id, country and name)
prometeo-cli
CLI Tool for communicating to banking institutions through Prometeo Open Banking API.
Setup
The CLI allows you to configure multiple institution's accounts and environments depending if you are working with production
, testing
or sandbox
.
- First of all set the environment variable
PROMETEO_ENVIRONMENT
with your working environment - Install the requirements with
pip install -r requirements.txt
- Run it with
python -m pmo COMMAND [ARGS]
When running it, the script will check if the directory ~/.prometeo/
and the file ~/.prometeorc
exists.
The ~/.prometeorc
file stores the api session key.
The ~/.prometeo/
directory stores two configurations files:
configuration.ini
stores the different environments' cofigurationcredentials.ini
stores the credentials of the institutions (The passwords are encrypted :stuck_out_tongue_winking_eye:)
Available commands
config [OPTIONS]
There are two options: --credential
for configuring a new set of credentials, and the --environment
for a new env.
login [OPTIONS]
Used for starting a new session
Options:
--provider
specifies the set of credentials to user (You can set a default provider with thePROMETEO_PROVIDER
environment variable)--interactive
to login interactively :smiley:
logout
Terminates the current session
accounts
Lists your banking accounts' details
cards
List your credit cards' details
movements [OPTIONS]
Lists your movements
Options All the options are required
(-a, --account) or (-c --card)
sets the origin of the movements(-cu, --currency)
As the credit cards movements might be in different currency you must specify one in ISO 4217--start-date
sets the start of the range of the movements to get in%Y-%m-%d
format--end-date
sets the end of the range of the movements to get in%Y-%m-%d
format
providers
Lists the available providers and their information (id, country and name) o
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 Distribution
Built Distribution
Hashes for prometeo_cli-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66e6ffcc99d3bd1b298a17a0d1fcde7a180f3111ebf13c3bc6f9714a0f672298 |
|
MD5 | 438215d5a2db74141f6a3f5db93834f6 |
|
BLAKE2b-256 | 8d4912da118b3a4a1fed025fad61b7bcec901d111107ef842b09b669fdd43ade |