Skip to content

Commit 904a3d8

Browse files
committed
Change readme to markdown
1 parent fc018f3 commit 904a3d8

File tree

2 files changed

+41
-17
lines changed

2 files changed

+41
-17
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# firebird-lib
2+
3+
## The Python library for Firebird
4+
5+
[![PyPI - Version](https://img.shields.io/pypi/v/firebird-lib.svg)](https://pypi.org/project/firebird-lib)
6+
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/firebird-lib.svg)](https://pypi.org/project/firebird-lib)
7+
[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
8+
9+
This package provides optional extensions for [firebird-driver](https://pypi.org/project/firebird-driver/).
10+
11+
Currently it contains modules for:
12+
13+
* Work with Firebird database schema.
14+
* Work with Firebird monitoring tables.
15+
* Processing output from gstat Firebird utility.
16+
* Processing Firebird server log.
17+
* Processing output from Firebird server trace & audit sessions.
18+
19+
-----
20+
21+
**Table of Contents**
22+
23+
- [Installation](#installation)
24+
- [License](#license)
25+
- [Documentation](#documentation)
26+
27+
## Installation
28+
29+
Requires: Firebird 3+
30+
31+
```console
32+
pip install firebird-lib
33+
```
34+
## License
35+
36+
`firebird-lib` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
37+
38+
## Documentation
39+
40+
The documentation for this package is available at [https://firebird-lib.readthedocs.io](https://firebird-lib.readthedocs.io)
41+

README.rst

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)