@@ -8,112 +8,42 @@ A Python client driver for Apache Cassandra. This driver works exclusively
88with the Cassandra Query Language v3 (CQL3) and Cassandra's native
99protocol. As such, only Cassandra 1.2+ is supported.
1010
11- **Warning **
12-
13- This driver is currently under heavy development, so the API and layout of
14- packages, modules, classes, and functions are subject to change. There may
15- also be serious bugs, so usage in a production environment is *not *
16- recommended at this time.
17-
18- * `JIRA <https://datastax-oss.atlassian.net/browse/PYTHON >`_
19- * `Mailing List <https://groups.google.com/a/lists.datastax.com/forum/#!forum/python-driver-user >`_
20- * IRC: #datastax-drivers on irc.freenode.net (you can use `freenode's web-based client <http://webchat.freenode.net/?channels=#datastax-drivers >`_)
21- * `Documentation <http://datastax.github.io/python-driver/index.html >`_
22-
23- Features to be Added
24- --------------------
25- * C extension for encoding/decoding messages
26- * Twisted, gevent support
27- * Python 3 support
28- * IPv6 Support
29-
3011Installation
3112------------
32- If you would like to use the optional C extensions, please follow
33- the instructions in the section below before installing the driver.
34-
3513Installation through pip is recommended::
3614
37- $ pip install cassandra-driver --pre
38-
39- If you want to install manually, you can instead do::
40-
41- $ pip install futures scales blist # install dependencies
42- $ python setup.py install
43-
44- C Extensions
45- ^^^^^^^^^^^^
46- By default, two C extensions are compiled: one that adds support
47- for token-aware routing with the Murmur3Partitioner, and one that
48- allows you to use libev for the event loop, which improves performance.
49-
50- When running setup.py, you can disable both with the ``--no-extensions ``
51- option, or selectively disable one or the other with ``--no-murmur3 `` and
52- ``--no-libev ``.
53-
54- To compile the extenions, ensure that GCC and the Python headers are available.
55-
56- On Ubuntu and Debian, this can be accomplished by running::
57-
58- $ sudo apt-get install build-essential python-dev
59-
60- On RedHat and RedHat-based systems like CentOS and Fedora::
15+ $ pip install cassandra-driver
6116
62- $ sudo yum install gcc python-devel
17+ For more complete installation instructions, see the
18+ `installation guide <http://datastax.github.io/python-driver/installation.html >`_.
6319
64- On OS X, homebrew installations of Python should provide the necessary headers.
20+ Documentation
21+ -------------
22+ All documentation for the python driver, including installation details, API documentation,
23+ and a Getting Started guide, can be found `here <http://datastax.github.io/python-driver/index.html >`_.
6524
66- libev support
67- ^^^^^^^^^^^^^
68- The driver currently uses Python's ``asyncore `` module for its default
69- event loop. For better performance, ``libev `` is also supported through
70- a C extension.
25+ Reporting Problems
26+ ------------------
27+ Please report any bugs and make any feature requests on the
28+ `JIRA <https://datastax-oss.atlassian.net/browse/PYTHON >`_ issue tracker.
7129
72- If you're on Linux, you should be able to install libev
73- through a package manager. For example, on Debian/Ubuntu::
30+ If you would like to contribute, please feel free to open a pull request.
7431
75- $ sudo apt-get install libev4 libev-dev
76-
77- On RHEL/CentOS/Fedora::
78-
79- $ sudo yum install libev libev-devel
80-
81- If you're on Mac OS X, you should be able to install libev
82- through `Homebrew <http://brew.sh/ >`_. For example, on Mac OS X::
83-
84- $ brew install libev
85-
86- If successful, you should be able to build and install the extension
87- (just using ``setup.py build `` or ``setup.py install ``) and then use
88- the libev event loop by doing the following:
89-
90- .. code-block :: python
91-
92- >> > from cassandra.io.libevreactor import LibevConnection
93- >> > from cassandra.cluster import Cluster
94-
95- >> > cluster = Cluster()
96- >> > cluster.connection_class = LibevConnection
97- >> > session = cluster.connect()
98-
99- Compression Support
100- ^^^^^^^^^^^^^^^^^^^
101- Compression can optionally be used for communication between the driver and
102- Cassandra. There are currently two supported compression algorithms:
103- snappy (in Cassandra 1.2+) and LZ4 (only in Cassandra 2.0+). If either is
104- available for the driver and Cassandra also supports it, it will
105- be used automatically.
106-
107- For lz4 support::
108-
109- $ pip install lz4
110-
111- For snappy support::
32+ Getting Help
33+ ------------
34+ Your two best options for getting help with the driver are the
35+ `mailing list <https://groups.google.com/a/lists.datastax.com/forum/#!forum/python-driver-user >`_
36+ and the IRC channel.
11237
113- $ pip install python-snappy
38+ For IRC, use the #datastax-drivers channel on irc.freenode.net. If you don't have an IRC client,
39+ you can use `freenode's web-based client <http://webchat.freenode.net/?channels=#datastax-drivers >`_.
11440
115- (If using a Debian Linux derivative such as Ubuntu, it may be easier to
116- just run ``apt-get install python-snappy ``.)
41+ Features to be Added
42+ --------------------
43+ * C extension for encoding/decoding messages
44+ * Twisted, gevent support
45+ * Python 3 support
46+ * IPv6 Support
11747
11848License
11949-------
0 commit comments