
##############################
The Python driver for Firebird
##############################

The `firebird-driver` package provides official `Python Database API 2.0`_-compliant driver
for the open source relational database `Firebird`_ ®. In addition to the minimal feature
set of the standard Python DB API, this driver also exposes the new (interface-based) client
API introduced in Firebird 3, and number of additional extensions and enhancements for
convenient use of Firebird RDBMS.

This documentation set is not a tutorial on SQL or Firebird; rather, it is a topical
presentation of driver's feature set, with example code to demonstrate basic usage patterns.
For detailed information about Firebird features, see the
`Firebird documentation <http://www.firebirdsql.org/en/documentation/>`__, and especially
the excellent `The Firebird Book <http://www.ibphoenix.com/products/books/firebird_book>`__
written by Helen Borrie and published by IBPhoenix_.

.. seealso:: `firebird-lib`_ package for optional extensions to this driver.

Content
*******

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   getting-started
   usage-guide
   python-db-api-compliance
   reference
   changelog
   license

Driver development is sponsored by IBPhoenix_.

Indices and tables
******************

* :ref:`genindex`
* :ref:`modindex`

.. _IBPhoenix: http://www.ibphoenix.com
.. _Python: http://python.org
.. _Python Database API 2.0: http://www.python.org/dev/peps/pep-0249/
.. _Firebird: http://www.firebirdsql.org
.. _under: http://www.firebirdsql.org/en/devel-python-driver/
.. _Firebird Project: http://www.firebirdsql.org
.. _IBPhoenix: http://www.ibphoenix.com
.. _firebird-lib: https://pypi.org/project/firebird-lib/
