github/sprockets.clients.cassandra
1
0
Fork 0
mirror of https://github.com/sprockets/sprockets.clients.cassandra.git synced 2024-11-21 19:28:36 +00:00
Code Issues Projects Releases Packages Wiki Activity
DEPRECATED
8 commits 1 branch 2 tags 61 KiB
Python 100%
Find a file
dave-shawley c348faf681 Merge pull request #2 from sprockets/initial-commit 
Initial commit
2015-05-12 08:52:36 -04:00
docs Fix build problems. 2015-05-11 13:25:04 -04:00
sprockets Address review feedback. 2015-05-11 16:13:13 -04:00
.coveragerc SYN 2015-05-06 14:51:41 -04:00
.gitignore SYN 2015-05-06 14:51:41 -04:00
.travis.yml Fix build problems. 2015-05-11 13:25:04 -04:00
dev-requirements.txt SYN 2015-05-06 14:51:41 -04:00
HISTORY.rst SYN 2015-05-06 14:51:41 -04:00
LICENSE SYN 2015-05-06 14:51:41 -04:00
MANIFEST.in SYN 2015-05-06 14:51:41 -04:00
README.rst SYN 2015-05-06 14:51:41 -04:00
requirements.txt Add Cassandra to project dependencies. 2015-05-06 16:17:04 -04:00
setup.cfg SYN 2015-05-06 14:51:41 -04:00
setup.py Address review feedback. 2015-05-11 16:13:13 -04:00
test-requirements.txt Address review feedback. 2015-05-11 16:13:13 -04:00
tests.py Address review feedback. 2015-05-11 16:13:13 -04:00
tox.ini Fix build problems. 2015-05-11 13:25:04 -04:00

README.rst 

sprockets.clients.cassandra
===========================

.. image:: https://coveralls.io/repos/aweber/sprockets.clients.cassandra/badge.png
   :target: https://coveralls.io/r/aweber/sprockets.clients.cassandra

.. image:: https://pypip.in/download/sprockets.clients.cassandra/badge.svg
   :target: https://pypi.python.org/pypi/sprockets.clients.cassandra/

.. image:: https://pypip.in/license/sprockets.clients.cassandra/badge.svg
   :target: https://pypi.python.org/pypi/sprockets.clients.cassandra/

.. image:: https://readthedocs.org/projects/sprockets.clients.cassandra/badge/?version=latest
   :target: http://sprockets.clients.cassandra.readthedocs.org/en/latest/

-----

.. important::

   Please send email to api@aweber.com and them them to update this README!

Quickstart Development Guide
----------------------------

1. Create a new virtual environment using `pyvenv`_ or `virtualenv`_ and
   **activate it**
2. Install development requirements - `pip install -r dev-requirements`
3. `./setup.py nosetests` will run the test suite with coverage enabled
4. `detox`_ is installed and will run the test suite across all supported
   python platforms
5. `./setup.py build_sphinx` will generate documentation into
   *build/sphinx/html*

TL;DR
+++++

::

    $ pyvenv env
    $ ./env/bin/pip install -qr dev-requirements.txt
    $ source env/bin/activate
    (env) $ ./setup.py nosetests
    (env) $ ./setup.py build_sphinx
    (env) $ detox

.. _detox: https://testrun.org/tox/
.. _pyvenv: https://docs.python.org/3/library/venv.html
.. _virtualenv: https://virtualenv.pypa.io/