A command-line interface for Seed Services HTTP APIs
Project description
A command line interface for Seed Services HTTP APIs.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for seed_services_cli-0.0.1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7b68cfe751810afabde31ce881b5a94bb848566f9d0abd9af52c1b1a49949d5 |
|
MD5 | 6ef821306f9585e973f816aafd4c4fcb |
|
BLAKE2b-256 | c9683529da4523c04fcc3191c6cb60cac09d2b96eaa4ad726388b5dcb8dd9035 |