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 -h
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] 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 <cik> (--type=client|dataport|datarule|dispatch) ...
exo [options] info <cik> <rid> [--cikonly]
exo [options] tree <cik> [--show-rid] [--show-aliases]
Options:
-h --help Show this screen.
-v --version Show version.
--host=<host> OneP URL. Default is $EXO\_HOST or m2.exosite.com.
--httptimeout=<sec> HTTP timeout setting.
--pretty Pretty print output
```
```bash
$ ./exodata -h
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.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
=================================
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 -h
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] 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 <cik> (--type=client|dataport|datarule|dispatch) ...
exo [options] info <cik> <rid> [--cikonly]
exo [options] tree <cik> [--show-rid] [--show-aliases]
Options:
-h --help Show this screen.
-v --version Show version.
--host=<host> OneP URL. Default is $EXO\_HOST or m2.exosite.com.
--httptimeout=<sec> HTTP timeout setting.
--pretty Pretty print output
```
```bash
$ ./exodata -h
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.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.5.tar.gz
(6.0 kB
view hashes)