Skip to content

Commit 022a384

Browse files
author
chenyunliang520
committed
Update project documentation and licensing to reflect fork status, remove outdated badges, add explicit LGPL v3 license details with redistribution notes, and configure setuptools to include LICENSE.txt in distributions
1 parent b50cd05 commit 022a384

File tree

4 files changed

+47
-13
lines changed

4 files changed

+47
-13
lines changed

gaussdb/README.rst

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,6 @@
11
gaussdb: GaussDB database adapter for Python
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-
164
This distribution contains the pure Python package ``gaussdb``.
175

186
.. Note::

gaussdb_pool/README.rst

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,25 @@ You can also install this package using::
1414
Please read `the project readme` and `the installation documentation` for
1515
more details.
1616

17+
|
1718
18-
Copyright (C) 2020 The Psycopg Team
19+
License
20+
-------
21+
22+
This project is a **fork** of `psycopg <https://www.psycopg.org/>`_, originally developed by the Psycopg Team.
23+
24+
- **Original work**: Copyright © 2020 The Psycopg Team
25+
- **Modifications**: Copyright © 2025 Huawei Cloud Developer Team
26+
- **License**: GNU Lesser General Public License v3.0 (`LGPL v3 <https://www.gnu.org/licenses/lgpl-3.0.en.html>`_)
27+
28+
**gaussdb_pool** inherits the same license. All modifications are distributed under the **LGPL v3**.
29+
30+
See the full license text in the :download:`LICENSE.txt` file.
31+
32+
.. note::
33+
34+
**Important**: When redistributing this package (including on PyPI), you **must** include the ``LICENSE.txt`` file.
35+
36+
|
37+
38+
.. _psycopg: https://www.psycopg.org/

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,6 @@ profile = "black"
6767
length_sort = true
6868
multi_line_output = 9
6969
sort_order = "gaussdb" # requires the isort-gaussdb module
70+
71+
[tool.setuptools]
72+
license-files = ["LICENSE.txt"]

tools/isort-gaussdb/README.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,26 @@ this plug-in is totally useless and the same can be done using isort features.
2727

2828
.. _isort: https://pycqa.github.io/isort/
2929
.. _gaussdb: https://www.huaweicloud.com/product/gaussdb.html
30+
31+
|
32+
33+
License
34+
-------
35+
36+
This project is a **fork** of `psycopg <https://www.psycopg.org/>`_, originally developed by the Psycopg Team.
37+
38+
- **Original work**: Copyright © 2020 The Psycopg Team
39+
- **Modifications**: Copyright © 2025 Huawei Cloud Developer Team
40+
- **License**: GNU Lesser General Public License v3.0 (`LGPL v3 <https://www.gnu.org/licenses/lgpl-3.0.en.html>`_)
41+
42+
**isort-gaussdb** inherits the same license. All modifications are distributed under the **LGPL v3**.
43+
44+
See the full license text in the :download:`LICENSE.txt` file.
45+
46+
.. note::
47+
48+
**Important**: When redistributing this package (including on PyPI), you **must** include the ``LICENSE.txt`` file.
49+
50+
|
51+
52+
.. _psycopg: https://www.psycopg.org/

0 commit comments

Comments
 (0)