summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Roberts <wizzat@gmail.com>2014-04-23 02:21:50 -0700
committerMark Roberts <wizzat@gmail.com>2014-04-23 02:21:50 -0700
commit7c21dfece73e717029c8a582a28ed9ff1f885cb7 (patch)
tree523641ed2937bb437717d319958cc1db08099e9a
parent7e5c847aa91de8786c08e8424519ddd22d5c67e8 (diff)
downloadkafka-python-7c21dfece73e717029c8a582a28ed9ff1f885cb7.tar.gz
Update README
-rw-r--r--README.md48
1 files changed, 25 insertions, 23 deletions
diff --git a/README.md b/README.md
index a315db6..ece8d80 100644
--- a/README.md
+++ b/README.md
@@ -155,6 +155,7 @@ python setup.py install
Download and build Snappy from http://code.google.com/p/snappy/downloads/list
+Linux:
```shell
wget http://snappy.googlecode.com/files/snappy-1.0.5.tar.gz
tar xzvf snappy-1.0.5.tar.gz
@@ -164,6 +165,11 @@ make
sudo make install
```
+OSX:
+```shell
+brew install snappy
+```
+
Install the `python-snappy` module
```shell
pip install python-snappy
@@ -173,40 +179,36 @@ pip install python-snappy
## Run the unit tests
-_These are broken at the moment_
-
-```shell
-tox ./test/test_unit.py
-```
-
-or
-
```shell
-python -m test.test_unit
+tox
```
## Run the integration tests
-First, checkout the Kafka source
+The integration tests will actually start up real local Zookeeper
+instance and Kafka brokers, and send messages in using the client.
+Note that you may want to add this to your global gitignore:
```shell
-git submodule init
-git submodule update
-cd kafka-src
-./sbt update
-./sbt package
-./sbt assembly-package-dependency
+.gradle/
+clients/build/
+contrib/build/
+contrib/hadoop-consumer/build/
+contrib/hadoop-producer/build/
+core/build/
+core/data/
+examples/build/
+perf/build/
```
-And then run the tests. This will actually start up real local Zookeeper
-instance and Kafka brokers, and send messages in using the client.
-
+First, check out and the Kafka source:
```shell
-tox ./test/test_integration.py
+git submodule update --init
+./build_integration.sh
```
-or
-
+Then run the tests against supported Kafka versions:
```shell
-python -m test.test_integration
+ KAFKA_VERSION=0.8.0 tox
+ KAFKA_VERSION=0.8.1 tox
```