mirror of
https://github.com/sprockets/sprockets.git
synced 2024-12-26 19:34:52 +00:00
Update the README and cli help
This commit is contained in:
parent
b03b3a36c8
commit
5f33a58c62
5 changed files with 49 additions and 27 deletions
|
@ -1,2 +1,2 @@
|
|||
include LICENSE
|
||||
include README.md
|
||||
include README.rst
|
||||
|
|
24
README.md
24
README.md
|
@ -1,24 +0,0 @@
|
|||
Sprockets
|
||||
=========
|
||||
A loosely coupled framework built on top of Tornado. Take what you need to build
|
||||
awesome applications.
|
||||
|
||||
CLI Usage
|
||||
---------
|
||||
|
||||
usage: sprockets [-h] [-l] [-d] [-s] [-v] [--version]
|
||||
{http,amqp} ... application
|
||||
|
||||
positional arguments:
|
||||
{http,amqp} Available sprockets application controllers
|
||||
http HTTP Application Controller
|
||||
amqp RabbitMQ Worker Controller
|
||||
application The sprockets app to run
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-l, --list List installed sprockets apps
|
||||
-d, --daemonize Fork into a background process
|
||||
-s, --syslog Log to syslog
|
||||
-v, --verbose Verbose logging output
|
||||
--version show program's version number and exit
|
45
README.rst
Normal file
45
README.rst
Normal file
|
@ -0,0 +1,45 @@
|
|||
Sprockets
|
||||
=========
|
||||
A loosely coupled framework built on top of Tornado. Take what you need to build
|
||||
awesome applications.
|
||||
|
||||
The core `sprockets` packages offers only the command line application for
|
||||
invoking Sprockets controllers such as the HTTP and AMQP controllers.
|
||||
|
||||
|Version| |Downloads| |Status| |Coverage| |License|
|
||||
|
||||
CLI Usage
|
||||
---------
|
||||
|
||||
usage: sprockets [-h] [-l] [-d] [-s] [-v] [--version]
|
||||
{http,amqp} ... application
|
||||
|
||||
positional arguments:
|
||||
{http,amqp} Available sprockets application controllers
|
||||
http HTTP Application Controller
|
||||
amqp RabbitMQ Worker Controller
|
||||
application The sprockets app to run
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-l, --list List installed sprockets apps
|
||||
-s, --syslog Log to syslog
|
||||
-v, --verbose Verbose logging output, use -vv for DEBUG level logging
|
||||
--version show program's version number and exit
|
||||
|
||||
|
||||
|
||||
.. |Version| image:: https://badge.fury.io/py/sprockets.svg?
|
||||
:target: http://badge.fury.io/py/sprockets
|
||||
|
||||
.. |Status| image:: https://travis-ci.org/sprockets/sprockets.svg?branch=master
|
||||
:target: https://travis-ci.org/sprockets/sprockets
|
||||
|
||||
.. |Coverage| image:: https://coveralls.io/repos/sprockets/sprockets/badge.png
|
||||
:target: https://coveralls.io/r/sprockets/sprockets
|
||||
|
||||
.. |Downloads| image:: https://pypip.in/d/sprockets/badge.svg?
|
||||
:target: https://pypi.python.org/pypi/sprockets
|
||||
|
||||
.. |License| image:: https://pypip.in/license/sprockets/badge.svg?
|
||||
:target: https://sprockets.readthedocs.org
|
2
setup.py
2
setup.py
|
@ -22,7 +22,7 @@ setup(name='sprockets',
|
|||
url='https://github.com/sprockets/sprockets',
|
||||
install_requires=requirements,
|
||||
license=open('LICENSE').read(),
|
||||
package_data={'': ['LICENSE', 'README.md']},
|
||||
package_data={'': ['LICENSE', 'README.rst']},
|
||||
packages=['sprockets'],
|
||||
classifiers=['Development Status :: 3 - Alpha',
|
||||
'Environment :: No Input/Output (Daemon)',
|
||||
|
|
|
@ -132,7 +132,8 @@ class CLI(object):
|
|||
|
||||
self._arg_parser.add_argument('-v', '--verbose',
|
||||
action='count',
|
||||
help='Verbose logging output')
|
||||
help=('Verbose logging output, use -vv '
|
||||
'for DEBUG level logging'))
|
||||
|
||||
self._arg_parser.add_argument('--version',
|
||||
action='version',
|
||||
|
|
Loading…
Reference in a new issue