Skip to content

Commit 40a34f5

Browse files
author
chenyunliang520
committed
Enhance README documentation: standardize project descriptions, add modifications list, update license details, and include PyPI badges
1 parent 58caaf3 commit 40a34f5

File tree

3 files changed

+44
-4
lines changed

3 files changed

+44
-4
lines changed

README.rst

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,26 @@ gaussdb -- GaussDB database adapter for Python
99
:target: https://github.com/HuaweiCloudDeveloper/gaussdb-python/blob/master/LICENSE.txt
1010
:alt: License: LGPL v3
1111

12-
**gaussdb** is a modern implementation of a GaussDB adapter for Python, based on a fork of `psycopg <https://www.psycopg.org/>`_ with enhancements and renaming.
13-
12+
**gaussdb** provides a modern Python interface for GaussDB, derived from a fork of `psycopg <https://www.psycopg.org/>`_ .
13+
It includes functional improvements and project renaming, retaining compatibility with the original codebase licensed under the **GNU Lesser General Public License v3.0**.
14+
15+
Modifications made by HuaweiCloudDeveloper:
16+
- Package name changed from `psycopg` to `gaussdb`
17+
- Introduced support for both pure-Python and libpq implementations via PSYCOPG_IMPL
18+
- Added GaussDB-specific behavior adjustments to handle differences from PostgreSQL
19+
- Added SSL connection examples and dedicated SSL demonstration code
20+
- Added installation tools for GaussDB client drivers in the tools/ directory
21+
- Introduced compatibility handling for GaussDB’s Oracle-mode SQL behavior
22+
- Added pre-commit hooks and stricter lint/tooling configuration
23+
- Expanded example scripts to cover GaussDB usage scenarios
24+
- Modularized the project into multiple packages (gaussdb, gaussdb_pool, isort-gaussdb) beyond psycopg’s structure
1425

1526
License
1627
-------
1728

1829
This project is a **fork** of `psycopg`, originally developed by the Psycopg Team.
1930

20-
- **Original work**: Copyright © 2001–2023 The Psycopg Team
31+
- **Original work**: Copyright © 2020 The Psycopg Team
2132
- **License**: GNU Lesser General Public License v3.0 (LGPL v3)
2233

2334
**gaussdb** inherits the same license. All modifications are distributed under the **LGPL v3**.

gaussdb/README.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ gaussdb: GaussDB database adapter for Python
99
:target: https://github.com/HuaweiCloudDeveloper/gaussdb-python/blob/master/LICENSE.txt
1010
:alt: License: LGPL v3
1111

12-
**gaussdb** is a modern implementation of a GaussDB adapter for Python, based on a fork of `psycopg <https://www.psycopg.org/>`_ with enhancements and renaming.
12+
**gaussdb** provides a modern Python interface for GaussDB, derived from a fork of `psycopg <https://www.psycopg.org/>`_ .
13+
It includes functional improvements and project renaming, retaining compatibility with the original codebase licensed under the **GNU Lesser General Public License v3.0**.
1314

1415

1516
This distribution contains the pure Python package ``gaussdb``.

tests/README.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,34 @@
11
gaussdb test suite
22
===================
33

4+
.. image:: https://img.shields.io/pypi/v/gaussdb.svg
5+
:target: https://pypi.org/project/gaussdb/
6+
:alt: PyPI version
7+
8+
.. image:: https://img.shields.io/pypi/l/gaussdb.svg
9+
:target: https://github.com/HuaweiCloudDeveloper/gaussdb-python/blob/master/LICENSE.txt
10+
:alt: License: LGPL v3
11+
12+
**gaussdb** provides a modern Python interface for GaussDB, derived from a fork of `psycopg <https://www.psycopg.org/>`_ .
13+
It includes functional improvements and project renaming, retaining compatibility with the original codebase licensed under the **GNU Lesser General Public License v3.0**.
14+
15+
License
16+
-------
17+
18+
This project is a **fork** of `psycopg`, originally developed by the Psycopg Team.
19+
20+
- **Original work**: Copyright © 2020 The Psycopg Team
21+
- **License**: GNU Lesser General Public License v3.0 (LGPL v3)
22+
23+
**gaussdb** inherits the same license. All modifications are distributed under the **LGPL v3**.
24+
25+
See the full license text in the :download:`LICENSE.txt` file.
26+
27+
.. note::
28+
29+
**Important**: When redistributing this package (including on PyPI), you **must** include the ``LICENSE.txt`` file.
30+
31+
432
Quick version
533
-------------
634

0 commit comments

Comments
 (0)