Skip to content

Commit

Permalink
Added polish and improved docs
Browse files Browse the repository at this point in the history
Removed example plugins from installation by default, updated plugins
README with more detailed instructions on developing and building.
  • Loading branch information
Dorthu committed Nov 29, 2018
1 parent 01e2f45 commit 4e9e208
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 56 deletions.
19 changes: 14 additions & 5 deletions linodecli/plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,25 @@ all information the plugin is given during invocation. This includes the follow
of the acting user. This is preferrable to using `requests` or another library
directly (see below).

### CLI Client
#### CLI Client

The CLI Client provided as `context.client` can make authenticated API calls on
behalf of the user using the provided `call_operation` method. This method is
invoked with a command and an action, and executes the given CLI command as if
it were entered into the command line, returning the resulting status code and
JSON data.

## TODOs
## Development

- [ ] Test/handle unconfigured invokations
- [ ] Finish statuspage plugin
- [ ] Clean up documentation
To develop a plugin, simply create a python source file in this directory that
has a `call` function as described above. To test, simply build the CLI as
normal (via `make install`) or simply by running `./setup.py install` in the
root directory of the project (this installs the code without generating new
baked data, and will only work if you've installed the CLI via `make install`
at least once, however it's a lot faster).

### Examples

This directory contains two example plugins, `echo.py.example` and
`regionstats.py.example`. To run these, simply remove the `.example` at the end
of the file and build the CLI as described above.
File renamed without changes.
File renamed without changes.
51 changes: 0 additions & 51 deletions linodecli/plugins/statuspage.py

This file was deleted.

0 comments on commit 4e9e208

Please sign in to comment.