summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2014-06-14 19:28:00 +0000
committerGerrit Code Review <review@openstack.org>2014-06-14 19:28:00 +0000
commitfb84de0828db118ee8a2f3311e37a58c5b7c8bc1 (patch)
tree7e3a3c5083fe88998e6f3a23d2b030fa4843fb2c /doc
parent96c1f6cb7a83d9c44d6d052c640d35071477d7c1 (diff)
parentb2c64e45d58e5dfcd98dd353ad9a6f32efd4134f (diff)
downloadoslo-db-fb84de0828db118ee8a2f3311e37a58c5b7c8bc1.tar.gz
Merge "Adding dependency documentation for MySQL."
Diffstat (limited to 'doc')
-rw-r--r--doc/source/installation.rst27
1 files changed, 24 insertions, 3 deletions
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 5c01c7a..254bd9b 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -4,9 +4,30 @@ Installation
At the command line::
- $ pip install
+ $ pip install oslo.db
Or, if you have virtualenvwrapper installed::
- $ mkvirtualenv
- $ pip install \ No newline at end of file
+ $ mkvirtualenv
+ $ pip install oslo.db
+
+You will also need to install at least one SQL backend::
+
+ $ pip install MySQL-python
+
+Or::
+
+ $ pip install pysqlite
+
+Using with MySQL
+----------------
+
+If using MySQL make sure to install the MySQL client development package for
+your distro. On Ubuntu this is done as follows::
+
+ $ sudo apt-get install libmysqlclient-dev
+ $ pip install MySQL-python
+
+The installation of MySQL-python will fail if libmysqlclient-dev is not
+installed first. Note that even in a virtual environment the MySQL package will
+be installed system wide. \ No newline at end of file