sprockets.clients.cassandra/README.rst

48 lines
1.7 KiB
ReStructuredText
Raw Normal View History

2015-05-06 18:51:41 +00:00
sprockets.clients.cassandra
===========================
Provides base functionality for asynchronously accessing/modifying
data in a Cassandra cluster from within Tornado.
2015-05-06 18:51:41 +00:00
Althought the underlying library supports several connection options,
this module currently only allows the hostname to be specified, and
that via an environment variable called CASSANDRA_URI as specified
in the docs.
2015-05-06 18:51:41 +00:00
|Version| |Downloads| |Status| |Coverage|
2015-05-06 18:51:41 +00:00
Documentation
-------------
https://sprocketsclientcassandra.readthedocs.org
2015-05-06 18:51:41 +00:00
Contributing
------------
This project follows the standard fork and pull request model of development.
If you want to contribute changes, then fork the project and code
away. To set up the environment:
2015-05-06 18:51:41 +00:00
* virtualenv env
* source env/bin/activate
* pip install -qr dev-requirements.txt
2015-05-06 18:51:41 +00:00
To test across supported platforms:
* tox
2015-05-06 18:51:41 +00:00
To build the docs (in *build/sphinx/html*):
* ./setup.py build_sphinx
2015-05-06 18:51:41 +00:00
Version History
---------------
See https://github.com/sprockets/sprockets.clients.cassandra/blob/master/HISTORY.rst
2015-05-06 18:51:41 +00:00
.. |Version| image:: https://badge.fury.io/py/sprockets.clients.cassandra.svg?
:target: https://badge.fury.io/py/sprockets.clients.cassandra
2015-05-06 18:51:41 +00:00
.. |Status| image:: https://travis-ci.org/sprockets/sprockets.clients.cassandra.svg?branch=master
:target: https://travis-ci.org/sprockets/sprockets.clients.cassandra
2015-05-06 18:51:41 +00:00
.. |Coverage| image:: https://codecov.io/github/sprockets/sprockets.clients.cassandra/coverage.svg?branch=master
:target: https://codecov.io/github/sprockets/sprockets.clients.cassandra?branch=master
2015-05-06 18:51:41 +00:00
.. |Downloads| image:: https://pypip.in/d/sprockets.clients.cassandra/badge.svg
:target: https://pypi.python.org/pypi/sprockets.clients.cassandra