============
Front Matter
============

Information about the SQLSoup project.

Project Homepage
================

SQLSoup is hosted on `Bitbucket <http://bitbucket.org>`_ - the lead project
page is at https://bitbucket.org/zzzeek/sqlsoup. Source code is tracked here
using `Mercurial <http://mercurial.selenic.com/>`_.

Releases and project status are available on Pypi at
http://pypi.python.org/pypi/sqlsoup.

The most recent published version of this documentation should be at
http://readthedocs.org/docs/sqlsoup/.

Project Status
==============

SQLSoup has been included with the SQLAlchemy distribution for many years.
As of 2012 it has been broken out into it's own project, where it can
be tracked and released separately.   The community is also invited to 
collaborate on Bitbucket, create forks, and improve the product.

.. _installation:

Installation
============

Install released versions of SQLSoup from the Python package 
index with `pip <http://pypi.python.org/pypi/pip>`_ or a similar tool::

    pip install sqlsoup

Installation via source distribution is via the ``setup.py`` script::

    python setup.py install

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

SQLSoup's install process will ensure that `SQLAlchemy <http://www.sqlalchemy.org>`_ 
is installed, in addition to other dependencies.  The 0.7 series of 
SQLAlchemy or greater is recommended.


Community
=========

SQLSoup was originally written by Jonathan Ellis.   It is under maintenance
by `Mike Bayer <http://techspot.zzzeek.org>`_, and is 
loosely associated with the `SQLAlchemy`_ project. 

.. _bugs:

Bugs
====

Bugs and feature enhancements to SQLSoup should be reported on the `Bitbucket
issue tracker <https://bitbucket.org/zzzeek/sqlsoup/issues?status=new&status=open>`_.  
