Metadata-Version: 2.1
Name: sqlalchemy-firebird
Version: 2.0.2
Summary: Firebird for SQLAlchemy
Author: F.D.Castel
Author-email: Gord Thompson <gord@gordthompson.com>, Paul Graves-DesLauriers <paul@dexmicro.com>
Maintainer-email: Paul Graves-DesLauriers <paul@dexmicro.com>
License: Copyright 2005-2023 SQLAlchemy authors and contributors <see AUTHORS file>.
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of
        this software and associated documentation files (the "Software"), to deal in
        the Software without restriction, including without limitation the rights to
        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
        of the Software, and to permit persons to whom the Software is furnished to do
        so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Documentation, https://github.com/pauldex/sqlalchemy-firebird/wiki
Project-URL: Source, https://github.com/pauldex/sqlalchemy-firebird
Project-URL: Tracker, https://github.com/pauldex/sqlalchemy-firebird/issues
Keywords: SQLAlchemy,Firebird,fdb,firebird-driver
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Database :: Front-Ends
Classifier: Operating System :: OS Independent
Requires-Python: !=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,>=2.7
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: SQLAlchemy<2.0,>=1.4; python_version < "3.8"
Requires-Dist: fdb; python_version < "3.8"
Requires-Dist: SQLAlchemy>=2.0; python_version >= "3.8"
Requires-Dist: firebird-driver; python_version >= "3.8"
Requires-Dist: packaging
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"

sqlalchemy-firebird
###################

An external SQLAlchemy dialect for Firebird
===========================================
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
.. image:: https://github.com/pauldex/sqlalchemy-firebird/workflows/sqlalchemy-firebird/badge.svg
    :target: https://github.com/pauldex/sqlalchemy-firebird

----

| This package provides a `Firebird <https://firebirdsql.org/en/start/>`_ dialect for `SQLAlchemy <https://www.sqlalchemy.org>`_ using the `firebird-driver <https://firebird-driver.readthedocs.io/en/latest>`_ and/or `fdb <https://fdb.readthedocs.io/en/latest>`_ driver.

****

**Installation**

::

    pip install sqlalchemy-firebird

If you are using Python 3.8 or greater, SQLAlchemy 2.0+ and firebird-driver will be automatically installed.
Python 3.6 and 3.7 will automatically install and use SQLAlchemy < 2.0 and fdb instead.

Connection URI samples for Firebird server installed on local machine using default port (3050):

::

    [Linux]
    # Use the fdb driver (Python 3.6/3.7)
    firebird+fdb://username:password@localhost///home/testuser/projects/databases/my_project.fdb
    # Use the firebird-driver driver (Python 3.8+)
    firebird+firebird://username:password@localhost///home/testuser/projects/databases/my_project.fdb

    [Windows]
    # Use the fdb driver (Python 3.6/3.7)
    firebird+fdb://username:password@localhost/c:/projects/databases/my_project.fdb
    # Use the firebird-driver driver (Python 3.8+)
    firebird+firebird://username:password@localhost/c:/projects/databases/my_project.fdb

****

**Usage**

For example, to connect to a Firebird server installed on a local Windows machine using the default port and firebird-driver:

::

    db_uri = "firebird+firebird://username:password@localhost/c:/projects/databases/my_project.fdb"
    from sqlalchemy import create_engine
    engine = create_engine(db_uri, echo=True)

Connecting to different types of Firebird servers, databases, or drivers is done simply by changing the db_uri string
used in the call to create_engine.

----

**Code of Conduct**

As with SQLAlchemy, sqlalchemy-firebird places great emphasis on polite, thoughtful, and
constructive communication between users and developers.
We use the SQLAlchemy `Code of Conduct <http://www.sqlalchemy.org/codeofconduct.html>`_.

----

**License**

sqlalchemy-firebird is distributed under the `MIT license
<http://www.opensource.org/licenses/mit-license.php>`_.
