Metadata-Version: 2.5
Name: firebird-lib
Version: 2.1.0
Summary: Firebird driver extension library
Project-URL: Home, https://github.com/FirebirdSQL/python3-lib
Project-URL: Documentation, https://firebird-lib.rtfd.io
Project-URL: Issues, https://github.com/FirebirdSQL/python3-lib/issues
Project-URL: Funding, https://github.com/sponsors/pcisar
Project-URL: Source, https://github.com/FirebirdSQL/python3-lib
Author-email: Pavel Cisar <pcisar@users.sourceforge.net>
License: MIT License
        
        Copyright (c) 2020 FirebirdSQL
        
        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.
License-File: LICENSE
Keywords: Firebird,RDBMS,driver,extension,library
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Topic :: Database
Classifier: Topic :: Software Development
Requires-Python: >=3.11
Requires-Dist: firebird-base~=2.0
Requires-Dist: firebird-driver~=2.1
Description-Content-Type: text/markdown

# firebird-lib

## The Python library for Firebird

[![PyPI - Version](https://img.shields.io/pypi/v/firebird-lib.svg)](https://pypi.org/project/firebird-lib)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/firebird-lib.svg)](https://pypi.org/project/firebird-lib)
[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/firebird-lib)](https://pypi.org/project/firebird-lib)
[![Libraries.io SourceRank](https://img.shields.io/librariesio/sourcerank/pypi/firebird-lib)](https://libraries.io/pypi/firebird-lib)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/FirebirdSQL/python3-lib)

This package provides optional extensions for [firebird-driver](https://pypi.org/project/firebird-driver/).

Currently it contains modules for:

* Work with Firebird database schema.
* Work with Firebird monitoring tables.
* Processing output from gstat Firebird utility.
* Processing Firebird server log.
* Processing output from Firebird server trace & audit sessions.

-----

**Table of Contents**

- [Installation](#installation)
- [Agent skill](#agent-skill)
- [License](#license)
- [Documentation](#documentation)
- [Development](#development)

## Installation

Requires: Firebird 3+

```console
pip install firebird-lib
```

## Agent skill

The [firebird-lib skill](skills/firebird-lib/SKILL.md) helps coding agents use this
package in other projects. Download `firebird-lib-<version>-skill.zip` from the
matching [GitHub release](https://github.com/FirebirdSQL/python3-lib/releases) when
the release includes the skill archive. Extract it into the user skill directory
for your agent; the archive contains a `firebird-lib` directory with `SKILL.md`
and its `references`:

| Agent | User skill directory |
| --- | --- |
| Codex | `~/.codex/skills/` |
| Claude Code | `~/.claude/skills/` |
| Gemini CLI | `~/.agents/skills/` |

For example, run `unzip firebird-lib-<version>-skill.zip -d ~/.codex/skills/`
to make the downloaded skill available to Codex across projects. From a checkout,
you can instead run `cp -R skills/firebird-lib ~/.codex/skills/`. Maintainers can
create the archive in `dist/` with `hatch run build-skill`.

## License

`firebird-lib` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

## Documentation

The documentation for this package is available at [https://firebird-lib.rtfd.io](https://firebird-lib.rtfd.io)

## Development

See the [development guide](development/README.md) for the project layout, test setup,
and module-specific maintenance notes.

