Metadata-Version: 2.1
Name: diet
Version: 0.1.8
Summary: Dash Import Export Tool
Home-page: https://bitbucket.org/sporga/diet
Author: Alexander Burgett
Author-email: alex.burgett@sprga.com.au
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: dash-api-python-client
Requires-Dist: dash-auth-python-client
Requires-Dist: requests-oauthlib

# DIET

Dash Import Export Tool

## Installation

```sh
pip install --user -U diet
```

## Usage

```
Dash Import and Export Tool

positional arguments:
  {import,export}  Action to perform
  target           The target of the import/export
  file             Files to import
```

**Import users into the system**
```sh
diet import user ./user-records.csv
```

## Configuration

**This file must be present for the application to operate**

All configuration settings are stored in ~/.diet/config.json


```json
{
    "auth": {
        "client_id": "",
        "client_secret": "",
        "host": "",
        "verify_ssl": true
    },
    "api": {
        "client_id": "",
        "client_secret": "",
        "host": "",
        "verify_ssl": true
    }
}
```

The top level property determines the service to configure, currently there are two services, **api** and **auth**. Api is the main application services and Auth is Sporga's Authenication service.

| Setting | Description |
|---------|-------------|
|client_id| The client id to authenticate with|
|client_secret| The client secret to authenticate with|
|host| The url of the service to import/export|
|verify_ssl| Enable/disable SSL certificate verifcation 

## Import file structure

### Supported file types
* CSV

#### CSV Structure
The CSV file must include a header row that matches the field's name you wish to import **exactly**

### User Import
| firstName | surname       | email                                                          | gender | address           | suburb    | state | mobilePhoneNumber | password  | postcode |
|-----------|---------------|----------------------------------------------------------------|--------|-------------------|-----------|-------|-------------------|-----------|----------|
| Test      | Administrator | csss@sporga.com.au                                             | Female | 20 resolution Dr  | Caringbah | NSW   | 61410100100       | ******* | 2229     |

