Metadata-Version: 2.0
Name: helium-commander
Version: 0.7.4
Summary: A CLI and service wrapper for the Helium API
Home-page: http://github.com/helium/helium-commander/
Author: Marc Nijdam
Author-email: marc@helium.com
License: BSD
Platform: all
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: click (>=6.6)
Requires-Dist: dpath (>=1.4)
Requires-Dist: futures (>=3.0)
Requires-Dist: requests (>=2.9)
Requires-Dist: terminaltables (>=2.1.0)
Requires-Dist: unicodecsv (>=0.14.1)

About
=====

Helium_ is an integrated platform of smart sensors, communication, edge
and cloud compute that enables numerous sensing applications.

This package makes it easy to talk to the Helium API_. It offers:

* A command line interface to interact with the various Helium
  endpoints
* A service API that shows how to communicate with the Helium API and
  interpret the results.

Installation
============


Source
------

Use this if you're actively developing or extending

::

    $ virtualenv env
    $ source env/bin/activate
    $ pip install -e .


PyPi
----

>From PyPi_. Use this if you want to use the
command line tool on its own.

::

    $ pip install helium-commander

Note that on some systems you may have to use `sudo` to install the
package system-wide

::

   $ sudo pip install helium-commander


Nix
---

helium-commander can also be installed using the Nix_ package manager. Clone
the repository and run:

::

   $ nix-env --install --file default.nix

To upgrade on version releases, run:

::

   $ nix-env --upgrade --file default.nix


Usage
=====

To use the `helium` command, explore the help options:

::

    $ helium --help
    Usage: helium [OPTIONS] COMMAND [ARGS]...

    Options:
      --version                Show the version and exit.
      --format [csv|json|tty]  The output format (default 'tty')
      --uuid                   Whether to display long identifiers
      --host TEXT              The Helium base API URL. Can also be specified
                               using the HELIUM_API_URL environment variable.
      --api-key TEXT           your Helium API key. Can also be specified using
                               the HELIUM_API_KEY environment variable
      -h, --help               Show this message and exit.

    Commands:
      cloud-script   Operations on cloud-scripts.
      element        Operations on elements.
      label          Operations on labels of sensors.
      organization   Operations on the authorized organization
      sensor         Operations on physical or virtual sensors.
      sensor-script  Operations on sensor-scripts.
      user           Operations on the user.

.. _Helium: https://helium.com
.. _API: https://docs.helium.com
.. _PyPi: https://pypi.python.org
.. _Nix: https://nixos.org/nix/


