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
Get identity details
Run:
$ seed-services-cli identity-get --identity uuid
to get a specific identity details dump to json
Identities Upload
Run:
$ seed-services-cli identity-import --help
to learn about the identity upload instructions.
Then to upload content create a CSV or JSON file
$ seed-services-cli identity-import --csv filename.csv
Find demo_import_identities.csv and .json in the repo route for format example.
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
Filters are available for message, messageset, lang and sequence_number.
Message Deletion
Run:
$ seed-services-cli sbm-messages-delete --help
to learn about deleting messages. Filters are available for message, messageset, lang and sequence_number.
Example that would purge all messages and binary files for messageset 1:
$ seed-services-cli sbm-messages-delete --messageset 1
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.
Release Notes
0.0.3 - 29-June-2016 - Added identity-get and identity-import.
0.0.2 - 28-June-2016 - Added sbm-messages-delete. Renamed short param from m to ms for messageset for sbm-messages command for consistency.
0.0.1 - Initial release
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.3-py2.7.egg
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0616f18595e7cdb956faa39cd1d5d0d031de1a7bc2e1d8c2f8e1fb9f7f8bed18 |
|
MD5 | 912476cd8aeb95be32c299cc1e00e5b3 |
|
BLAKE2b-256 | f6aa7008ee4c8a837bbf8c06ace439bf84107d59321d94ee28089f3f8ad41e02 |