Skip to content

Commit e8d5eaf

Browse files
committed
Change readme to markdown
1 parent dbe9552 commit e8d5eaf

File tree

2 files changed

+40
-13
lines changed

2 files changed

+40
-13
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# firebird-driver
2+
3+
## Firebird driver for Python
4+
5+
[![PyPI - Version](https://img.shields.io/pypi/v/firebird-base.svg)](https://pypi.org/project/firebird-base)
6+
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/firebird-base.svg)](https://pypi.org/project/firebird-base)
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 official Python Database API 2.0-compliant driver for the open
10+
source relational database Firebird®. In addition to the minimal feature set of
11+
the standard Python DB API, this driver also exposes the new (interface-based)
12+
client API introduced in Firebird 3, and number of additional extensions and
13+
enhancements for convenient use of Firebird RDBMS.
14+
15+
-----
16+
17+
**Table of Contents**
18+
19+
- [Installation](#installation)
20+
- [License](#license)
21+
- [Documentation](#documentation)
22+
23+
## Installation
24+
25+
Requires: Firebird 3+
26+
27+
```console
28+
pip install firebird-driver
29+
```
30+
See [firebird-lib](https://pypi.org/project/firebird-lib/) package for optional extensions
31+
to this driver.
32+
33+
## License
34+
35+
`firebird-driver` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
36+
37+
## Documentation
38+
39+
The documentation for this package is available at [https://firebird-driver.readthedocs.io](https://firebird-driver.readthedocs.io)
40+

README.rst

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

0 commit comments

Comments
 (0)