obp-python 0.2

Beta Open Bank Project Python Utilities

Python Utilities to make working with Open Bank Project api easier

• uses python3

Install

pip install obp-python # Requires at least python 3

If your operating system defaults to python two, you might need to run pip3 install obp-python # Requires at least python 3

Run

e.g.

obp # Displays available commands
obp init # initalise against an open bank project instance
obp addrole --role-name CanCreateSandbox
obp sandboximport --example Import a very small sample dataset

Other Utilities

Prefix all these commands with obp:

• getauth : Get a direct login token
• addrole : Add a role to your user (only if super user)
• getuser : Get your user info
• getuserid: Get yur user id only
• sandboximport --example : import ver small sample dataset
• sandboximport --input example.json : import own dataset (must be obp format)

Development / Contributing

Note You can ignore this is your just using the utlity. This is just for developing the utlity.

To work on this utility as a developer:

Building

# Setup python3 environment
virtualenv -p python3 venv
. venv/bin/activate
git clone <this-repo>
# Building wheels etc
python setup.py sdist bdist_wheel
# Installing your edits locally:
pip install -e <path-to-this-repo> # -e means Install  a  project  in editable mode (i.e.  setuptools "developmode")
# Work on utility..submit pull request 

Update history

• 0.19 Added sandboximport utility obp sandboximport --example
• 0.0.9 Switch to use OBP_API_HOST instead of OBP_ENDPOINT