oslo.db/doc/source/installation.rst
Doug Hellmann cae12025a9 Clean up documentation
Switch to manually generated rst files for the API documentation so we
do not expose private parts of the library.

Fix formatting of usage.rst

Convert bullet list to section headers to fix rendering issues and make
the docs more readable.

Fix formatting of docstrings in classes exposed in the docs to eliminate
warnings/errors from Sphinx.

Add history.rst

Change-Id: I6f500775f801558f7c0c29f180b60f83a7150e02
2014-09-04 16:27:00 -04:00

632 B

Installation

At the command line:

$ 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.