Merge pull request #5 from thegeorgeous/develop

v1.0.0

.codeclimate.yml

@@ -0,0 +1,19 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - python
+  fixme:
+    enabled: true
+  pep8:
+    enabled: true
+  radon:
+    enabled: true
+ratings:
+  paths:
+  - "**.py"
+exclude_paths:
+  - "docs/*"
+  - "examples/*"

.travis.yml

@@ -9,7 +9,7 @@ python:
 env:
   - CASSANDRA_DRIVER_VERSION=2.6.0
   - CASSANDRA_DRIVER_VERSION=2.7.2
-
+  - CASSANDRA_DRIVER_VERSION=3.0.0
 install:
   - pip install -q cassandra-driver==$CASSANDRA_DRIVER_VERSION
   - pip install -q flask

README.md

@@ -1,10 +1,11 @@
 # Flask-CQLAlchemy
 
 [![Latest Version](https://img.shields.io/pypi/v/flask-cqlalchemy.svg)](https://pypi.python.org/pypi/Flask-CQLAlchemy)
+[![Build Status](https://travis-ci.org/thegeorgeous/flask-cqlalchemy.svg?branch=master)](https://travis-ci.org/thegeorgeous/flask-cqlalchemy)
+[![Code Climate](https://codeclimate.com/github/thegeorgeous/flask-cqlalchemy/badges/gpa.svg)](https://codeclimate.com/github/thegeorgeous/flask-cqlalchemy)
 [![Downloads](https://img.shields.io/pypi/dm/flask-cqlalchemy.svg)](https://pypi.python.org/pypi/Flask-CQLAlchemy)
 
 
-
 Flask-CQLAlchemy handles connections to Cassandra clusters
 and gives a unified easier way to declare models and their
 columns
@@ -14,6 +15,12 @@ columns
 pip install flask-cqlalchemy
 ```
 
+## Dependencies
+As such Flask-CQLAlchemy depends only on the cassandra-driver. It is assumed that you already have flask installed.
+
+Flask-CQLAlchemy has been tested with versions 2.6.0, 2.7.2, 3.0.0 of cassandra-driver. It is known to work with all versions >=2.5, but use it at your own risk.
+All previous versions of Flask-CQLAlchemy are deprecated.
+
 ## Example
 ```
 #example_app.py
@@ -37,8 +44,7 @@ Start a python shell
 ```
 >>from example_app import db, User
 >>db.sync_db()
->>user1 = User(username='John Doe')
->>user1.save()
+>>user1 = User.create(username='John Doe')
 ```
 For a complete list of available method refer to the cqlengine [Model documentation](http://datastax.github.io/python-driver/api/cassandra/cqlengine/models.html)
 
@@ -54,3 +60,6 @@ CQLAlchemy provides all the option available in the cqlengine connection.setup()
 
 ## Tutorial
 For a tutorial on how to use Flask-CQLAlchemy check this [post](http://thegeorgeous.com/2015/06/17/creating-a-tumblelog-with-flask-and-flask-cqlalchemy-I.html)
+
+## Contributing
+Found a bug? Need a feature? Open it in issues, or even better, open a PR. Please include tests in the PR.

docs/index.rst

@@ -20,6 +20,12 @@ Installation
 
    $ pip install flask-cqlalchemy
 
+Dependencies
+------------
+As such Flask-CQLAlchemy depends only on the cassandra-driver. It is assumed that you already have flask installed.
+
+Flask-CQLAlchemy has been tested with versions 2.6.0, 2.7.2, 3.0.0 of cassandra-driver. It is known to work with all versions >=2.5, but use it at your own risk.
+All previous versions of Flask-CQLAlchemy are deprecated.
 
 Example
 -------
@@ -49,8 +55,7 @@ Start a python shell
 
    >>from example_app import db, User
    >>db.sync_db()
-   >>user1 = User(username='John Doe')
-   >>user1.save()
+   >>user1 = User.create(username='John Doe')
 
 For a complete list of available method refer to the cqlengine `Model documentation <http://datastax.github.io/python-driver/api/cassandra/cqlengine/models.html>`_
 

setup.py

@@ -2,10 +2,9 @@
 Flask-CQLAlchemy
 ----------------
 
-Flask-CQLAlchemy handles connections to Cassandra clusters
-and gives a unified easier way to declare models and their
-columns
-
+Flask-CQLAlchemy handles connections to Cassandra clusters and provides a
+Flask-SQLAlchemy like interface to declare models and their columns in a Flask
+app
 Links
 `````
 
@@ -18,12 +17,12 @@
 
 setup(
     name='Flask-CQLAlchemy',
-    version='0.2.0',
+    version='1.0.0',
     url='http://thegeorgeous.com/flask-cqlalchemy',
     license='BSD',
-    author='George',
+    author='George Thomas',
     author_email='iamgeorgethomas@gmail.com',
-    description='Flask-CQLAlchemy handles connections to Cassandra clusters through the cqlengine',
+    description='Flask-CQLAlchemy handles connections to Cassandra clusters and provides an interface through cqlengine',
     long_description=__doc__,
     keywords='cassandra cqlengine flask',
     packages=['flask_cqlalchemy'],
@@ -35,7 +34,7 @@
         'blist'
     ],
     classifiers=[
-        'Development Status :: 4 - Beta',
+        'Development Status :: 5 - Production/Stable',
         'Environment :: Web Environment',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: BSD License',

tests/test_cqlalchemy.py

@@ -2,16 +2,19 @@
 import uuid
 from flask import Flask
 from flask.ext.cqlalchemy import CQLAlchemy
-from cassandra.cqlengine.management import drop_keyspace, create_keyspace_simple
+from cassandra.cqlengine.management import drop_keyspace
+from cassandra.cqlengine.management import create_keyspace_simple
 from cassandra.cqlengine import models
 
+
 def make_user_model(db):
     class User(db.Model):
         uuid = db.columns.UUID(primary_key=True, default=uuid.uuid4)
         username = db.columns.Text(index=True, required=False)
 
     return User
 
+
 class BasicTestCase(unittest.TestCase):
 
     def setUp(self):
@@ -29,7 +32,6 @@ def setUp(self):
     def tearDown(self):
         drop_keyspace("cqlengine")
 
-
     def test_sync_db(self):
         self.db.sync_db()
         user = self.User.create(username="JohnDoe")