summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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