..  spinedb_api front matter
    Created: 18.6.2018

.. _SQLAlchemy: http://www.sqlalchemy.org/


************
Front matter
************

Information about the Spine database API project.

.. contents::
   :local:


Project homepage
----------------

Spine database API is hosted on GitHub at https://github.com/spine-tools/Spine-Database-API
under the Spine project.


.. _installation:

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

If you have installed `Spine Toolbox <https://github.com/spine-tools/Spine-Toolbox>`_,
you should readily have Spine database API.
Just activate the Python environment for Toolbox and you are good to go.

Otherwise, you can install released versions of Spine database API with Pip
into the current Python environment::

  pip install spinedb-api

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

Spine database API's install process will ensure that SQLAlchemy_ is installed,
in addition to other dependencies. Spine database API will work with SQLAlchemy version 1.4.


Bugs
----

Bugs and feature enhancements to Spine database API should be reported on the
`GitHub issue tracker <https://github.com/spine-tools/Spine-Database-API/issues>`_.