Skip to content
This repository has been archived by the owner on Sep 20, 2023. It is now read-only.

Commit

Permalink
add CLI info to README
Browse files Browse the repository at this point in the history
  • Loading branch information
tylerdave committed Jan 7, 2017
1 parent f97eb84 commit 30e0997
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ Installation
pip install BloomSky-API
To install optional command-line interface (requires click):

.. code-block:: bash
pip install BloomSky-API[cli]
Usage
~~~~~
Expand All @@ -62,6 +68,27 @@ You can either store the API key in an environment variable named
client = bloomsky_api.BloomSkyAPIClient(api_key='Your-real-API-key-goes-here')
data = client.get_data()
Command Line Interface
~~~~~~~~~~~~~~~~~~~~~~

If you install the optional command-line interface, the `bloomsky-api` command will be available. Usage:

.. code-block:: none
Usage: bloomsky-api [OPTIONS]
Retrieve data from the BloomSky API and output it as JSON.
Options:
--api-key TEXT BloomSky API key (can be set via env var
BLOOMSKY_API_KEY).
--api-url TEXT Override BloomSky API endpoint URL.
--json-indent INTEGER Number of spaces to indent nested JSON levels.
--help Show this message and exit.
Data
~~~~

Expand Down

0 comments on commit 30e0997

Please sign in to comment.