Skip to main content

Beta Open Bank Project Python Utilities

Project description

Python Utilities to make working with Open Bank Project api easier

  • uses python3


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



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:

# Setup python3 environment
virtualenv -p python3 venv
. venv/bin/activate
git clone <this-repo>
# Building wheels etc
python 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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
obp_python-0.187-py3-none-any.whl (21.5 kB) Copy SHA256 hash SHA256 Wheel py3

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page