prepare 6.8.0 release (#104)

Author: eli-darkly

.circleci/config.yml

@@ -17,13 +17,16 @@ test-template: &test-template
         command: |
           sudo pip install --upgrade pip setuptools;
           sudo pip install -r test-requirements.txt;
+          if [[ "$CIRCLE_JOB" != "test-3.3" ]] && [[ "$CIRCLE_JOB" != "test-3.4" ]]; then
+            sudo pip install -r consul-requirements.txt;
+          fi;
           sudo python setup.py install;
           pip freeze
     - run:
         name: run tests
         command: |
           mkdir test-reports;
-          if [[ $CIRCLE_JOB == test-2.7 ]]; then
+          if [[ "$CIRCLE_JOB" == "test-2.7" ]]; then
             pytest -s --cov=ldclient --junitxml=test-reports/junit.xml testing;
             sh -c '[ -n "${CODECLIMATE_REPO_TOKEN+1}" ] && codeclimate-test-reporter || echo "No CODECLIMATE_REPO_TOKEN value is set; not publishing coverage report"';
           else
@@ -41,33 +44,39 @@ jobs:
       - image: circleci/python:2.7-jessie
       - image: redis
       - image: amazon/dynamodb-local
+      - image: consul
   test-3.3:
     <<: *test-template
     docker:
       - image: circleci/python:3.3-jessie
       - image: redis
       - image: amazon/dynamodb-local
+      # python-consul doesn't support Python 3.3
   test-3.4:
     <<: *test-template
     docker:
       - image: circleci/python:3.4-jessie
       - image: redis
       - image: amazon/dynamodb-local
+      # python-consul doesn't support Python 3.4
   test-3.5:
     <<: *test-template
     docker:
       - image: circleci/python:3.5-jessie
       - image: redis
       - image: amazon/dynamodb-local
+      - image: consul
   test-3.6:
     <<: *test-template
     docker:
       - image: circleci/python:3.6-jessie
       - image: redis
       - image: amazon/dynamodb-local
+      - image: consul
   test-3.7:
     <<: *test-template
     docker:
       - image: circleci/python:3.7-stretch
       - image: redis
       - image: amazon/dynamodb-local
+      - image: consul

CONTRIBUTING.md

@@ -8,7 +8,7 @@ Development information (for developing this module itself)
 
 1. One-time setup:
 
-       mkvirtualenv python-client
+        mkvirtualenv python-client
 
 1. When working on the project be sure to activate the python-client virtualenv using the technique of your choosing.
 
@@ -17,13 +17,17 @@ Development information (for developing this module itself)
         pip install -r requirements.txt
         pip install -r test-requirements.txt
 
-1. Run tests: You'll need redis running locally on its default port of 6379.
+1. When running unit tests, in order for `test_feature_store.py` to run, you'll need all of the supported databases (Redis, Consul, DynamoDB) running locally on their default ports.
+
 1. If you want integration tests to run, set the ```LD_SDK_KEY``` environment variable to a valid production SDK Key.
+
 1. ```$ py.test testing```
 
-Developing with different python versions
+1. All code must be compatible with all supported Python versions as described in README. Most portability issues are addressed by using the `six` package. We are avoiding the use of `__future__` imports, since they can easily be omitted by mistake causing code in one file to behave differently from another; instead, whenever possible, use an explicit approach that makes it clear what the desired behavior is in all Python versions (e.g. if you want to do floor division, use `//`; if you want to divide as floats, explicitly cast to floats).
+
+Developing with different Python versions
 -----------------------------------------
 
-Example for switching to python 3:
+Example for switching to Python 3:
 
 ```virtualenv -p `which python3` ~/.virtualenvs/python-client```

README.md

@@ -81,7 +81,9 @@ The SDK is tested with the most recent patch releases of Python 2.7, 3.3, 3.4, 3
 Database integrations
 ---------------------
 
-Feature flag data can be kept in a persistent store using Redis or DynamoDB. These adapters are implemented in the `DynamoDB` and `Redis` classes in `ldclient.integrations`; to use them, call the `new_feature_store` method in the appropriate class, and put the returned object in the `feature_store` property of your client configuration. See [`ldclient.integrations`](https://github.com/launchdarkly/python-client-private/blob/master/ldclient/integrations.py) and the [SDK reference guide](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store) for more information.
+Feature flag data can be kept in a persistent store using Consul, DynamoDB, or Redis. These adapters are implemented in the `Consul`, `DynamoDB` and `Redis` classes in `ldclient.integrations`; to use them, call the `new_feature_store` method in the appropriate class, and put the returned object in the `feature_store` property of your client configuration. See [`ldclient.integrations`](https://github.com/launchdarkly/python-client-private/blob/master/ldclient/integrations.py) and the [SDK reference guide](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store) for more information.
+
+Note that Consul is not supported in Python 3.3 or 3.4.
 
 Using flag data from a file
 ---------------------------

consul-requirements.txt

@@ -0,0 +1 @@
+python-consul>=1.0.1

demo/demo.py

@@ -1,5 +1,3 @@
-from __future__ import print_function
-
 import logging
 import sys
 

ldclient/client.py

@@ -1,12 +1,8 @@
-from __future__ import division, with_statement, absolute_import
-
 import hashlib
 import hmac
 import threading
 import traceback
 
-from builtins import object
-
 from ldclient.config import Config as Config
 from ldclient.event_processor import NullEventProcessor
 from ldclient.feature_requester import FeatureRequesterImpl

ldclient/event_processor.py

@@ -1,5 +1,3 @@
-from __future__ import absolute_import
-
 from collections import namedtuple
 from email.utils import parsedate
 import errno

ldclient/feature_requester.py

@@ -1,5 +1,3 @@
-from __future__ import absolute_import
-
 from collections import namedtuple
 import json
 import urllib3