Source

django-mssql / docs / quickstart.txt

Quickstart
==========

Installation
------------

* Install ``django-mssql`` with your favorite Python package manager::

    pip install django-mssql


* Add the DATABASES configuration.

    .. code-block:: django
    
        DATABASES = {
            'default': {
                'NAME': 'my_database',
                'ENGINE': 'sqlserver_ado',
                'HOST': 'dbserver\\ss2008',
                'USER': '',
                'PASSWORD': '',
                'OPTIONS' : {
                    'provider': 'SQLOLEDB',
                    'use_mars': True,
                },
            }
        }

    .. note:: Although the project is named ``django-mssql`` the python module is named ``sqlserver_ado``.

Dependencies
------------

Django
^^^^^^

Django_ 1.2 and newer are supported by the current release. Support for Django 1.1 requires getting code from tag ``legacy-1.1``.

.. _Django: http://www.djangoproject.com/

Python
^^^^^^

This backend requires Python 2.6 or newer. Python 3.x support will be investigated when Django supports it.

PyWin32
^^^^^^^

PyWin32_ build 212 or newer is required.

.. _PyWin32: http://sourceforge.net/projects/pywin32/
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.