Metadata-Version: 2.1
Name: obp-python
Version: 0.199
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


## Open Bank Project CLI
A command line utility (CLI) to work with the Open Bank Project sandbox called `obp`.

With the obp cli you can:

- Initiate an api connection to the sandbox 
  - *note* you still need to sign-up from the sandbox homepage first to create your username & password
- Get your DirectLogin token
- Get your user information
- Get your user id 
- Get banks 
- Get (your) accounts held at the bank

Also, depending on your account access you may:
- Create a bank account
- Add roles to a user
- Import/Delete branches
- Import dummy bank data 


## Install

- Requires python3
- Requires pip (see https://pip.pypa.io/en/stable/installing/)

```
pip install --user obp-python # Requires at least python 3
```

> Warning: If your operating system defaults to python 2, your pip command might be:

```
pip3 install --user obp-python
#or 
pip3.6 install --user obp-python
```


## 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
  getaccountbyid      📁 Get account by id (includes balance)
  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
  importaccounts      🚜 Import accounts from spreadsheet template
  importbranches      🚜 Import branches from spreadsheet template
  importcustomers     🚜 Import customers from spreadsheet template
  importtransactions  🚜 Import transactions from spreadsheet template
  importusers         🚜 Import users from spreadsheet template
  init                💡 Initalize connection to your Open Bank Project...
  sandboximport       🚜 Bulk import sandbox data from json input
```

## Examples

You must initalize the obp cli once, by doing:
```
obp init
```

### Generate Direct Login Token
```
obp init 
Please enter your API_HOST: api.example.com
Please enter your username:
Please enter your password: : 
Repeat for confirmation: 
... generating direct login token
Please enter your OBP_CONSUMER_KEY: # Go to api.example.com, then "Get API Key" to generate consumer key.
obp getauth # Displays your DirectLogin token
```


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


