File tree Expand file tree Collapse file tree 1 file changed +14
-17
lines changed Expand file tree Collapse file tree 1 file changed +14
-17
lines changed Original file line number Diff line number Diff line change @@ -5,55 +5,52 @@ Confluent's Apache Kafka client for Python
5
5
Prerequisites
6
6
===============
7
7
8
- librdkafka >=0.9.1 (or master>=2016-04-13)
9
- py.test (pip install pytest)
8
+ librdkafka >=0.9.1 (or master>=2016-04-13)
9
+ py.test (pip install pytest)
10
10
11
11
12
12
Build
13
13
=====
14
14
15
- For Python 2:
15
+ python setup.by build
16
16
17
- python setup.by build
18
-
19
-
20
- For Python 3:
21
-
22
- python3 setup.by build
23
17
24
18
25
19
Install
26
20
=======
27
21
Preferably in a virtualenv:
28
22
29
- pip install .
23
+ pip install .
30
24
31
25
32
26
Run unit-tests
33
27
==============
34
28
35
- py.test
29
+ py.test
36
30
37
31
38
32
Run integration tests
39
33
=====================
40
- WARNING:: These tests require an active Kafka cluster and will make use of
41
- a topic named 'test'.
34
+ ** WARNING** : These tests require an active Kafka cluster and will make use of a topic named 'test'.
42
35
43
- ./integration_test.py <kafka-broker >
36
+ ./integration_test.py <kafka-broker>
44
37
45
38
46
39
47
40
Generate documentation
48
41
======================
49
42
50
- make docs
43
+ make docs
51
44
52
45
or:
53
46
54
- python setup.by build_sphinx
47
+ python setup.by build_sphinx
48
+
55
49
50
+ Documentation will be generated in ` docs/_build/ `
56
51
57
- Documentation will be generated in docs/_ build/
58
52
53
+ Examples
54
+ ========
59
55
56
+ See [ examples] ( examples )
You can’t perform that action at this time.
0 commit comments