Metadata-Version: 2.1
Name: obp-python
Version: 0.192
Summary: Beta Open Bank Project Python Utilities
Home-page: https://github.com/chrisjsimpson/open-bank-project-python
Author: 
Author-email: 
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Requires-Python: >=3
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: requests
Requires-Dist: appdirs
Requires-Dist: dms2dec
Requires-Dist: pyexcel-ods

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` 

## Usage
```
Usage: obp [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  addaccount       📁 Add a bank account
  addrole          🚧 Add a role for current user
  adduser          📝 Add a user
  deletebranches   ⚠️ 🏦 Delete all branches
  getaccountsheld  📁 Get list of accounts held
  getauth          🔑 Get your DirectLogin token
  getbanks         🏦 Get list of banks
  getuser          😃 Get your user info
  getuserid        📋 Get your user id
  importbranches   🚜 Import branches from spreadsheet template
  init             💡 Initalize connection to your Open Bank Project instance
  sandboximport    🚜 Bulk import sandbox data from json input
```


#### Development / Contributing (Development only)

> **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`


