-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
23 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,33 @@ | ||
Examples | ||
======== | ||
|
||
Go to the source code by clicking on the headline. | ||
The examples can be found on github in the | ||
`examples <https://github.com/innot/argparseDecorator/tree/master/examples>`_ folder. | ||
You can go directly to the source file by clicking on the title of the example. | ||
|
||
`simple_cli.py <https://github.com/innot/argparseDecorator/blob/master/examples/simple_cli.py>`_ | ||
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
|
||
This is a very simple cli that takes input from stdin. It has a few sample commands that show a few basic features of | ||
the argparseDecorator. | ||
|
||
|
||
`simple_asyncio_demo.py <https://github.com/innot/argparseDecorator/blob/master/examples/simple_asyncio_demo.py>`_ | ||
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
|
||
A very small sample to test using argparseDecorator in an asyncio context. | ||
|
||
|
||
`ssh_cli.py <https://github.com/innot/argparseDecorator/blob/master/examples/ssh_cli.py>`_ | ||
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | ||
|
||
is a more involved demo that shows how argparseDecorator can be used to create a CLI that can be accessed remotly via | ||
ssh. | ||
|
||
Full Documentation | ||
------------------ | ||
|
||
.. automodule:: ssh_cli | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters