README.md

firebird-driver

Firebird driver for Python

This 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.

---

Table of Contents

• Installation
• License
• Documentation

Installation

Requires: Firebird 3+

pip install firebird-driver

See firebird-lib package for optional extensions to this driver.

License

firebird-driver is distributed under the terms of the MIT license.

Documentation

The documentation for this package is available at https://firebird-driver.readthedocs.io

Running tests

This project uses hatch , so you can use:

hatch test

to run all tests for default Python version (3.11). To run tests for all Python versions defined in matrix, use -a switch.

This project is using pytest for testing, and our tests add several options via tests/conftest.py.

By default, tests are configured to use local Firebird installation via network access. To use local instllation in mebedded mode, comment out the section:

[tool.hatch.envs.hatch-test]
extra-args = ["--host=localhost"]

in pyproject.toml.

You can also use firebird driver configuration file to specify server(s) that should be used for testing, and then pass --driver-config and --server options to pytest.