Gridworks Debug Cli#

Internal debugging tools for Gridworks systems:

brew install awscli
aws configure
pip install gridworks-debug-cli
gwd --help
gwd csv --help
gwd csv egd --help
gwd events --help
gwd events mkconfig
gwd events show

This tool will be maintained only as long as it is internally useful. YMMV.

Features#

Event viewing, either from local directory of events or from the cloud, via events subcommand.
Data download, via csv subcommand.

Requirements#

awscli. This should be installable per Amazon instructions or on a mac with:
```
brew install awscli
```
AWS credentials from Gridworks installed per Amazon instructions or:
```
aws configure
```

Installation#

You can install Gridworks Debug Cli via pip from PyPI:

Install awscli per per Amazon instructions or on a mac with:

brew install awscli

Get AWS credentials from Gridworks and install them with:

aws configure

Install gridworks-debug-cli with:

pip install gridworks-debug-cli

Vieweing events#

Configure events subcommand with:

gwd events mkconfig
open $HOME/.config/gridworks/debug-cli/events/gwd.events.config.json

You must fill in values for the following keys with information from Gridworks:

{
  "mqtt": {
    "hostname": "USE REAL VALUE",
    "password": "USE REAL VALUE",
    "username": "USE REAL VALUE"
  },
  "sync": {
    "s3": {
      "bucket": "USE REAL VALUE",
      "prefix": "USE REAL VALUE",
      "profile": "USE NAME YOU CHOSE in 'aws configure'"
    }
  }
}

Data download#

Configure csv subcommand with:

gwd csv mkconfig
open $HOME/.config/gridworks/debug-cli/csv/gwd.csv.config.json

Usage#

Please see the Command-line Reference for details.

Contributing#

Contributions are very welcome. To learn more, see the Contributor Guide.

License#

Distributed under the terms of the MIT license, Gridworks Debug Cli is free and open source software.

Issues#

If you encounter any problems, please file an issue along with a detailed description.

Credits#

This project was generated from @cjolowicz’s Hypermodern Python Cookiecutter template.