You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-6Lines changed: 20 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -11,20 +11,35 @@ apt-get install python-dev
11
11
pip install lightstep
12
12
```
13
13
14
-
## Getting started
14
+
## Developer Setup
15
15
16
-
Please see the [example programs](examples/) for examples of how to use this library. In particular:
16
+
### Prerequisites
17
+
*[PyEnv](https://github.com/pyenv/pyenv)
17
18
18
-
*[Trivial Example](examples/trivial/main.py) shows how to use the library on a single host.
19
-
*[Context in Headers](examples/http/context_in_headers.py) shows how to pass a `TraceContext` through `HTTP` headers.
19
+
```python
20
+
pyenv install 2.7.15
21
+
pyenv install 3.4.9
22
+
pyenv local 2.7.15 3.4.9
23
+
```
20
24
21
-
You can run the examples by doing:
25
+
*[Tox](https://pypi.org/project/tox/)
22
26
```python
23
27
tox
28
+
```
29
+
30
+
* Run the examples:
31
+
```python
24
32
source .tox/py27/bin/activate
25
33
python examples/nontrivial/main.py
26
34
```
27
35
36
+
## Getting Started with Tracing
37
+
38
+
Please see the [example programs](examples/) for examples of how to use this library. In particular:
39
+
40
+
*[Trivial Example](examples/trivial/main.py) shows how to use the library on a single host.
41
+
*[Context in Headers](examples/http/context_in_headers.py) shows how to pass a `TraceContext` through `HTTP` headers.
42
+
28
43
Or if your python code is already instrumented for OpenTracing, you can simply switch to LightStep's implementation with:
29
44
30
45
```python
@@ -43,4 +58,3 @@ if __name__ == "__main__":
43
58
```
44
59
45
60
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.
0 commit comments