From 74c9ef96f1fcaa2c599b083850e1f2d6428f2b10 Mon Sep 17 00:00:00 2001 From: David Beitey Date: Thu, 14 Feb 2019 06:21:47 +0000 Subject: [PATCH] Add driver install instructions to README This adds details about the fact that a driver is required for pyodbc and how to find details on installation. --- README.rst | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 52d93001..a0dddcac 100644 --- a/README.rst +++ b/README.rst @@ -29,19 +29,25 @@ Features Dependencies ------------ -- Django 2.1 -- pyodbc 3.0 or newer +- Django 2.1 +- pyodbc 3.0 or newer +- Appropriate driver installed and configured for use by pyodbc Installation ------------ -1. Install pyodbc and Django +#. Install pyodbc and Django -2. Install django-pyodbc-azure :: +#. Install your chosen ODBC driver and ensure it is available to pyodbc. + Setup depends on your operating system; install instructions for + most platforms are available on the `pyodbc wiki + `_. + +#. Install django-pyodbc-azure :: pip install django-pyodbc-azure -3. Now you can point the ``ENGINE`` setting in the settings file used by +#. Now you can point the ``ENGINE`` setting in the settings file used by your Django application or project to the ``'sql_server.pyodbc'`` module path :: @@ -125,6 +131,10 @@ Dictionary. Current available keys are: String. ODBC Driver to use (``"ODBC Driver 13 for SQL Server"``, ``"SQL Server Native Client 11.0"``, ``"FreeTDS"`` etc). Default is ``"ODBC Driver 13 for SQL Server"``. + + The specified driver must be installed and available to + ``pyodbc``; follow instructions on the `pyodbc wiki `_ + for how to install the relevant drivers on your system. - isolation_level @@ -152,7 +162,7 @@ Dictionary. Current available keys are: definition present in the ``freetds.conf`` FreeTDS configuration file instead of a hostname or an IP address. - But if this option is present and it's value is ``True``, this + But if this option is present and its value is ``True``, this special behavior is turned off. See http://www.freetds.org/userguide/dsnless.htm for more information.