Skip to main content

Command line interface for Exosite platform.

Project description

Exoline: Command Line for Exosite
=================================

Exoline is a set of commands for accessing the Exosite [One Platform](http://exosite.com/products/onep) from the command line.

- **exo** - command for the [RPC API](http://developers.exosite.com/display/OP/Remote+Procedure+Call+API)

- **exodata** - command for the [HTTP Data Interface API](http://developers.exosite.com/display/OP/HTTP+Data+Interface+API)


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

To install the latest released version of exoline:

```bash

$ pip install exoline

```

Alternatively, install straight from github:

```bash

$ pip install -e git://github.com/dweaver/exoline#egg=exoline

```


Environment Variables
---------------------

For convenience, several command line options may be replaced by environment variables.

* EXO\_HOST: host, e.g. m2.exosite.com. This supplies --host to exo and --url for exodata.


Help
----

For help, run each command with -h from the command line. For example:

```bash

$ exo --help

Exosite RPC API Command Line Interface
Provides command line access to the Remote Procedure Call API:
http://developers.exosite.com/display/OP/Remote+Procedure+Call+API

Usage:
exo [options] read [--follow] [--limit=<limit>] [--selection=all|autowindow|givenwindow] <cik> <rid>
exo [options] write <cik> <rid> <value>
exo [options] create-dataport <cik> (--format=binary|boolean|float|integer|string) [--name=<name>]
exo [options] create-client <cik> [--name=<name>]
exo [options] map <cik> <rid> <alias>
exo [options] drop <cik> <rid> ...
exo [options] listing [--plain] <cik> (--type=client|dataport|datarule|dispatch) ...
exo [options] info <cik> <rid> [--cikonly]
exo [options] tree <cik> [--show-rid] [--show-aliases]
exo [options] lookup-rid <cik> <cik-to-find>
exo [options] drop-all-children <cik>

Options:
--host=<host> OneP URL. Default is $EXO_HOST or m2.exosite.com.
--httptimeout=<sec> HTTP timeout setting.
--pretty Pretty print output
-h --help Show this screen.
-v --version Show version.


```

```bash

$ exodata --help
Exosite Data API Command Line Interface
Provides access to the HTTP Data Interface API:
http://developers.exosite.com/display/OP/HTTP+Data+Interface+API

Usage:
exodata read [options] <cik> <alias> ...
exodata write [options] <cik> <alias>=<value> ...
exodata ip [options]

Options:
-h --help Show this screen
-v --version Show version
--url=<url> One Platform URL [default: http://m2.exosite.com]

```

Examples
--------

TODO: Usage examples.


History
=======

0.0.8 (2013-6-26)
-----------------

- Added units to tree output, support writing negative numeric values

0.0.7 (2013-6-23)
-----------------

- Time series data write and read commands, with --follow option


0.0.6 (2013-6-23)
-----------------

- RID lookup and bulk drop commands


0.0.5 (2013-6-21)
-----------------

- Install two command line scripts: exo, exodata


0.0.4 (2013-6-18)
-----------------

- Complete Exosite Data API
- Subset of Exosite RPC API

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

exoline-0.0.8.tar.gz (7.2 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page