Skip to content

Commit 406a64d

Browse files
committed
Move some doc installation sections
1 parent d0dbb44 commit 406a64d

File tree

2 files changed

+51
-47
lines changed

2 files changed

+51
-47
lines changed

docs/installation.rst

Lines changed: 48 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,54 @@ You can use ``pip install --pre cassandra-driver`` if you need to install a beta
2020

2121
***Note**: if intending to use optional extensions, install the `dependencies <#optional-non-python-dependencies>`_ first. The driver may need to be reinstalled if dependencies are added after the initial installation.
2222

23+
Verifying your Installation
24+
---------------------------
25+
To check if the installation was successful, you can run::
26+
27+
python -c 'import cassandra; print cassandra.__version__'
28+
29+
It should print something like "3.21.0".
30+
31+
.. _installation-datastax-graph:
32+
33+
(*Optional*) DataStax Graph
34+
---------------------------
35+
The driver provides an optional fluent graph API that depends on Apache TinkerPop (gremlinpython). It is
36+
not installed by default. To be able to build Gremlin traversals, you need to install
37+
the `graph` requirements::
38+
39+
pip install cassandra-driver[graph]
40+
41+
See :doc:`graph_fluent` for more details about this API.
42+
43+
(*Optional*) Compression Support
44+
--------------------------------
45+
Compression can optionally be used for communication between the driver and
46+
Cassandra. There are currently two supported compression algorithms:
47+
snappy (in Cassandra 1.2+) and LZ4 (only in Cassandra 2.0+). If either is
48+
available for the driver and Cassandra also supports it, it will
49+
be used automatically.
50+
51+
For lz4 support::
52+
53+
pip install lz4
54+
55+
For snappy support::
56+
57+
pip install python-snappy
58+
59+
(If using a Debian Linux derivative such as Ubuntu, it may be easier to
60+
just run ``apt-get install python-snappy``.)
61+
62+
(*Optional*) Metrics Support
63+
----------------------------
64+
The driver has built-in support for capturing :attr:`.Cluster.metrics` about
65+
the queries you run. However, the ``scales`` library is required to
66+
support this::
67+
68+
pip install scales
69+
70+
2371
Speeding Up Installation
2472
^^^^^^^^^^^^^^^^^^^^^^^^
2573

@@ -80,53 +128,6 @@ Once the dependencies are installed, simply run::
80128

81129
python setup.py install
82130

83-
Verifying your Installation
84-
---------------------------
85-
To check if the installation was successful, you can run::
86-
87-
python -c 'import cassandra; print cassandra.__version__'
88-
89-
It should print something like "2.7.0".
90-
91-
.. _installation-datastax-graph:
92-
93-
(*Optional*) DataStax Graph
94-
---------------------------
95-
The driver provides an optional fluent graph API that depends on Apache TinkerPop (gremlinpython). It is
96-
not installed by default. To be able to build Gremlin traversals, you need to install
97-
the `graph` requirements::
98-
99-
pip install cassandra-driver[graph]
100-
101-
See :doc:`graph_fluent` for more details about this API.
102-
103-
(*Optional*) Compression Support
104-
--------------------------------
105-
Compression can optionally be used for communication between the driver and
106-
Cassandra. There are currently two supported compression algorithms:
107-
snappy (in Cassandra 1.2+) and LZ4 (only in Cassandra 2.0+). If either is
108-
available for the driver and Cassandra also supports it, it will
109-
be used automatically.
110-
111-
For lz4 support::
112-
113-
pip install lz4
114-
115-
For snappy support::
116-
117-
pip install python-snappy
118-
119-
(If using a Debian Linux derivative such as Ubuntu, it may be easier to
120-
just run ``apt-get install python-snappy``.)
121-
122-
(*Optional*) Metrics Support
123-
----------------------------
124-
The driver has built-in support for capturing :attr:`.Cluster.metrics` about
125-
the queries you run. However, the ``scales`` library is required to
126-
support this::
127-
128-
pip install scales
129-
130131

131132
(*Optional*) Non-python Dependencies
132133
------------------------------------

docs/upgrading.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ need to change only the first module of your import statements, not the submodul
4444
from cassandra.auth import PlainTextAuthProvider
4545
from cassandra.policies import WhiteListRoundRobinPolicy
4646
47+
Also note that the cassandra.hosts module doesn't exist in cassandra-driver. This
48+
module is named cassandra.pool.
49+
4750
dse-graph
4851
^^^^^^^^^
4952

0 commit comments

Comments
 (0)