Metadata-Version: 2.0
Name: behavioral-signals-cli
Version: 0.1.0
Summary: Command Line Interface for Behavioral Signals Emotion and     Behavior Recognition Engine in the Cloud
Home-page: https://bitbucket.org/behavioralsignals/api-cli/src
Author: Behavioral Signals
Author-email: nassos@behavioralsignals.com
License: MIT license
Download-URL: https://bitbucket.org/behavioralsignals/api-cli/get/1.0.0.tar.gz
Description-Content-Type: UNKNOWN
Keywords: behavioral_signals_cli
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: behavioral-signals-swagger-client
Requires-Dist: requests

# Behavioral Signals CLI

Command Line Interface for Behavioral Signals' Emotion and Behavior Recognition in the Cloud


* Free software: MIT license

## Getting Started

1. First request your account id and token for the Behavioral Signals Web API by sending an email to nassos@behavioralsignals.com
2. Export the following as environmental variables:
```
   export BEST_ID=your_id_on_service_api
   export BEST_TOKEN=your_token_for_service_api
```
3. Run the CLI to submit your audio files:
```
   behaviorals_signals_cli send_audio [csv_file] [pids_log]
```

   The .csv file must have the following form (order matters):
path/to/file, number of channels, call direction, agentId, agentTeam, campaign Id, calltype, calltime, timezone, ANI. The [pids_log] file
is an empty file where the process ids of the created jobs will be written.
4. Run the CLI to get the emotion/behavior recognition, diarization and other results:
```
   behaviorals_signals_cli get_results [pids_log] [results_dir]
```
   The results will be written as .json files inside [results_dir] (polling may be performed if results
   are not readily available).
5. Run the CLI to get ASR results:
```
   behaviorals_signals_cli get_results_asr [pids_log] [results_dir]
```
   The results will be written as "[filename]_[pid]_words.json" files inside [results_dir] (polling may be performed if results
   are not readily available).


Type:
```
   behavioral_signals_cli --help 
```
for more info.


Features
--------
The CLI allows you to easily:

- Submit multiple audio files to API,
- Get behavior and emotion recognition results
- Get speech recognition results

* TODO

Credits
---------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage



=======
History
=======

0.1.0 (2017-11-17)
------------------

* First release on PyPI.


