github/sprockets.cli
1
0
Fork 0
mirror of https://github.com/sprockets/sprockets.cli.git synced 2024-09-28 02:00:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

README formatting updates

Browse source
This commit is contained in:
Gavin M. Roy 2014-10-14 16:38:59 -04:00
parent fdae6b6f89
commit 3e9ac83d08
1 changed files with 21 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.rst
View file

@ -12,6 +12,11 @@ using setuptools entry points.
Example CLI Usage Example CLI Usage
----------------- -----------------
Help
````
.. code::
# sprockets --help # sprockets --help
usage: sprockets [-h] [--apps] [--plugins] [-e [PLUGIN]] [-s] [-v] [--version] usage: sprockets [-h] [--apps] [--plugins] [-e [PLUGIN]] [-s] [-v] [--version]
@ -39,7 +44,12 @@ Example CLI Usage
Find more Sprockets controllers and plugins at Find more Sprockets controllers and plugins at
https://sprockets.readthedocs.org https://sprockets.readthedocs.org
Starting a Web App with the NewRelic plugin
```````````````````````````````````````````
.. code::
# sprockets -e newrelic http my_web_app
Controllers Controllers
----------- -----------
@ -52,7 +62,7 @@ to inject configuration directives into the cli.
Controller API Summary: Controller API Summary:
.. code: python .. code:: python
module.add_cli_arguments(ArgumentParser) # optional module.add_cli_arguments(ArgumentParser) # optional
module.main(app_module, argparse.Namespace) module.main(app_module, argparse.Namespace)
@ -69,7 +79,7 @@ method is defined, it will be invoked when a controller has shutdown.
Plugin API Summary: Plugin API Summary:
.. code: python .. code:: python
plugin.initialize(controller_module) # optional plugin.initialize(controller_module) # optional
plugin.on_start(controller_module) # optional plugin.on_start(controller_module) # optional
@ -82,17 +92,17 @@ Applications can be a python package or module and if they are registered
to a specific controller, can be referenced by an alias. Application contracts to a specific controller, can be referenced by an alias. Application contracts
vary by controller. vary by controller.
.. |Version| image:: https://badge.fury.io/py/sprockets.svg? .. |Version| image:: https://badge.fury.io/py/sprockets.cli.svg?
:target: http://badge.fury.io/py/sprockets :target: http://badge.fury.io/py/sprockets.cli
.. |Status| image:: https://travis-ci.org/sprockets/sprockets.svg?branch=master .. |Status| image:: https://travis-ci.org/sprockets/sprockets.cli.svg?branch=master
:target: https://travis-ci.org/sprockets/sprockets :target: https://travis-ci.org/sprockets/sprockets.cli
.. |Coverage| image:: https://coveralls.io/repos/sprockets/sprockets/badge.png .. |Coverage| image:: https://coveralls.io/repos/sprockets/sprockets.cli/badge.png
:target: https://coveralls.io/r/sprockets/sprockets :target: https://coveralls.io/r/sprockets/sprockets.cli
.. |Downloads| image:: https://pypip.in/d/sprockets/badge.svg? .. |Downloads| image:: https://pypip.in/d/sprockets.cli/badge.svg?
:target: https://pypi.python.org/pypi/sprockets :target: https://pypi.python.org/pypi/sprockets.cli
.. |License| image:: https://pypip.in/license/sprockets/badge.svg? .. |License| image:: https://pypip.in/license/sprockets.cli/badge.svg?
:target: https://sprockets.readthedocs.org :target: https://sprockets.readthedocs.org