Update README
This commit is contained in:
52
README.md
52
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
|
||||
|
||||
```shell
|
||||
git submodule init
|
||||
git submodule update
|
||||
cd kafka-src
|
||||
./sbt update
|
||||
./sbt package
|
||||
./sbt assembly-package-dependency
|
||||
```
|
||||
|
||||
And then run the tests. This will actually start up real local Zookeeper
|
||||
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
|
||||
tox ./test/test_integration.py
|
||||
.gradle/
|
||||
clients/build/
|
||||
contrib/build/
|
||||
contrib/hadoop-consumer/build/
|
||||
contrib/hadoop-producer/build/
|
||||
core/build/
|
||||
core/data/
|
||||
examples/build/
|
||||
perf/build/
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
First, check out and the Kafka source:
|
||||
```shell
|
||||
python -m test.test_integration
|
||||
git submodule update --init
|
||||
./build_integration.sh
|
||||
```
|
||||
|
||||
Then run the tests against supported Kafka versions:
|
||||
```shell
|
||||
KAFKA_VERSION=0.8.0 tox
|
||||
KAFKA_VERSION=0.8.1 tox
|
||||
```
|
||||
|
Reference in New Issue
Block a user