Merge pull request #50 from lightstep/sarah/LS-5226

LS-5226: Updated README and Tox with functional developer setup

Author: frenchfrywpepper

.circleci/config.yml

@@ -12,7 +12,7 @@ jobs:
     - checkout
     - run: mkdir -p $CIRCLE_ARTIFACTS $CIRCLE_TEST_REPORTS
     - run: sudo pip install tox
-    - run: make test
+    - run: make test27
     - store_test_results:
         path: /tmp/circleci-test-results
     - store_artifacts:
@@ -32,7 +32,7 @@ jobs:
     - checkout
     - run: mkdir -p $CIRCLE_ARTIFACTS $CIRCLE_TEST_REPORTS
     - run: sudo pip install tox
-    - run: make test
+    - run: make test34
     - store_test_results:
         path: /tmp/circleci-test-results
     - store_artifacts:

.gitignore

@@ -10,3 +10,5 @@ dist/*
 .DS_Store
 **/.DS_Store
 .idea
+.pytest_cache/
+.python-version

Makefile

@@ -49,6 +49,12 @@ publish: dist
 example: build
 	python examples/trivial/main.py
 
+test27: build
+	tox -e py27
+
+test34: build
+	tox -e py34
+
 test: build
 	tox
 

README.md

@@ -11,20 +11,35 @@ apt-get install python-dev
 pip install lightstep
 ```
 
-## Getting started
+## Developer Setup
 
-Please see the [example programs](examples/) for examples of how to use this library. In particular:
+### Prerequisites
+* [PyEnv](https://github.com/pyenv/pyenv)
 
-* [Trivial Example](examples/trivial/main.py) shows how to use the library on a single host.
-* [Context in Headers](examples/http/context_in_headers.py) shows how to pass a `TraceContext` through `HTTP` headers.
+```python
+pyenv install 2.7.15
+pyenv install 3.4.9
+pyenv local 2.7.15 3.4.9
+```
 
-You can run the examples by doing:
+* [Tox](https://pypi.org/project/tox/)
 ```python
 tox
+```
+
+* Run the examples:
+```python
 source .tox/py27/bin/activate
 python examples/nontrivial/main.py
 ```
 
+## Getting Started with Tracing
+
+Please see the [example programs](examples/) for examples of how to use this library. In particular:
+
+* [Trivial Example](examples/trivial/main.py) shows how to use the library on a single host.
+* [Context in Headers](examples/http/context_in_headers.py) shows how to pass a `TraceContext` through `HTTP` headers.
+
 Or if your python code is already instrumented for OpenTracing, you can simply switch to LightStep's implementation with:
 
 ```python
@@ -43,4 +58,3 @@ if __name__ == "__main__":
 ```
 
 This library is the LightStep binding for [OpenTracing](http://opentracing.io/). See the [OpenTracing Python API](https://github.com/opentracing/opentracing-python) for additional detail.
-

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-; envlist = py26, py27, py34
+envlist = py27, py34
 
 [testenv]
 deps =