Metadata-Version: 2.0
Name: seed-services-cli
Version: 0.0.1
Summary: A command-line interface for Seed Services HTTP APIs
Home-page: http://github.com/praekelt/seed-services-cli
Author: Praekelt Foundation and Individual Contributors
Author-email: support@praekeltfoundation.com
License: BSD
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Requires-Dist: click
Requires-Dist: click-config
Requires-Dist: demands (==3.0.0)

Seed Services command line interface
====================================

A command line interface for `Seed Services`_ HTTP APIs.

.. _Seed Services: https://github.com/praekelt?utf8=%E2%9C%93&query=seed


Installation
------------

Install with::

  $ pip install --user seed-services-cli

Then run::

  $ seed-services-cli --help

and read the usage instructions.


Configuration
----------------

The configuration can be passed in using a YAML file. An example is provided::

  hub:
    api_url: http://hub.example.org/api/v1
    token: TEMP
  identity_store:
    api_url: http://idstore.example.org/api/v1
    token: TEMP2

Then run the following to use::

  $ seed-services-cli --conf=config.yaml command-to-run



Finding identities
------------------

Run::

  $ seed-services-cli identity-search --help

to learn about the options available for searching.

Example search::

  $ seed-services-cli identity-search --address_type msisdn --address +27001


Messages Listing and Upload
---------------------------

Run::

  $ seed-services-cli sbm-messagesets --help

to learn about the messagesets available for uploading to.

Run::

  $ seed-services-cli sbm-messages-import --help

to learn about the message upload instructions.

Then to upload content create a CSV or JSON file ::

  $ seed-services-cli sbm-messages-import --csv filename.csv

Note: To upload binary content the file name should in the binary_content field
and this will be uploaded for you.

To retrieve messages run::

  $ seed-services-cli sbm-messages --help


Developing
----------------

Run::

  $ pip install --editable .

Testing::

  $ pip install -r requirements-dev.txt
  $ py.test seed_services_cli



Reporting issues
----------------

Issues can be filed in the GitHub issue tracker. Please don't use the issue
tracker for general support queries.


