Skip to content
This repository was archived by the owner on Oct 29, 2021. It is now read-only.

Commit f151f75

Browse files
author
Stephen Gutekanst
committed
python: update README to mention installation instructions.
1 parent 5ac0922 commit f151f75

1 file changed

Lines changed: 14 additions & 5 deletions

File tree

‎python/README.md‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,20 @@ pip install strict-rfc3339
3434

3535
Depending on where Python is installed and/or what permissions the directory has, you may need to run the above `easy_install` and `pip` commands as root.
3636

37+
## Installation
38+
39+
To install Appdash into your Python path (i.e. so you can import it into your own code), simply change directory to `sourcegraph.com/sourcewgraph/appdash/python` and run the traditional `setup.py` script:
40+
41+
```
42+
# Install Python-appdash:
43+
cd $GOPATH/src/sourcegraph.com/sourcegraph/appdash/python
44+
python setup.py install
45+
```
46+
47+
Again, depending on where Python is installed and/or what permissions the directory has, you may need to run the above `setup.py` script as root.
48+
49+
To test that installation went well, in any directory _except that one_, you can launch an interactive Python interpreter and simply `import appdash`.
50+
3751
## Twisted Example
3852

3953
If all is well with your setup, you should be able to change directory to `sourcegraph.com/sourcewgraph/appdash/python` and run the Twisted example:
@@ -59,8 +73,3 @@ appdash serve
5973
cd $GOPATH/src/sourcegraph.com/sourcegraph/appdash/python
6074
./example_socket.py
6175
```
62-
63-
## TODO
64-
65-
- Provide a way to easily install python' appdash module.
66-

0 commit comments

Comments
 (0)