Merge pull request #15 from pangpang20/master

Add PyPI upload step to release workflow and enhance database compatibility handling

Author: liubao68

.github/workflows/release.yml

@@ -3,7 +3,7 @@ name: Build and Release
 on:
   push:
     tags:
-      - "v*.*.*"
+      - "*"
 
 permissions:
   contents: write
@@ -56,3 +56,12 @@ jobs:
         uses: softprops/action-gh-release@v1
         with:
           files: all_dist/*
+
+      - name: Upload to PyPI
+        if: startsWith(github.ref, 'refs/tags/')
+        run: |
+          pip install --upgrade twine
+          twine upload all_dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/tests.yml

@@ -83,7 +83,7 @@ jobs:
 
       - name: Create test database
         run: |
-          docker exec opengauss-custom bash -c "su - omm -c 'gsql -d postgres -c \"CREATE DATABASE test DBCOMPATIBILITY '\''PG'\'';\"'"
+          docker exec opengauss-custom bash -c "su - omm -c 'gsql -d postgres -c \"CREATE DATABASE test ;\"'"
 
       - name: Create report directory
         run: |

README.rst

@@ -45,9 +45,17 @@ EulerOS x86_64 systems, you can obtain it by running::
     # libpq.so.5.5 (libc6,x86-64) => /tmp/lib/libpq.so.5.5
     ldconfig -p | grep pq
 
+Installation from PyPI:
 
+    python3 -m venv test_env
+    source test_env/bin/activate
+    pip install --upgrade pip
+    pip install isort-gaussdb
+    pip install gaussdb
+    pip install gaussdb-pool
+    python -c "import gaussdb; print(gaussdb.__version__)"  # Outputs: 1.0.0.dev2
 
-You can then clone this repository to develop GaussDB::
+You can also clone this repository to develop GaussDB::
 
     # Create a new Python virtual environment in the .venv directory
     python -m venv .venv

docs/index.rst

@@ -42,6 +42,7 @@ Release notes
 
     news
     news_pool
+    news_isort
 
 
 Indices and tables

docs/news.rst

@@ -7,9 +7,6 @@
 ``gaussdb`` release notes
 =========================
 
-Future releases
----------------
-
 gaussdb.0b1
 ^^^^^^^^^^^^^
 

docs/news_isort.rst

@@ -0,0 +1,12 @@
+.. currentmodule:: isort_gaussdb
+
+.. index::
+    single: Release notes
+    single: News
+
+``isort_gaussdb`` release notes
+===================================
+
+Current release
+---------------
+- First release on PyPI.

docs/news_pool.rst

@@ -10,161 +10,4 @@
 Current release
 ---------------
 
-gaussdb_pool 3.2.6
-^^^^^^^^^^^^^^^^^^
-
-- Reset transaction status of connection failing check (:ticket:`#1014`).
-
-
-gaussdb_pool 3.2.5
-^^^^^^^^^^^^^^^^^^
-
-- Fix spurious warning logging on pool shrinking (:ticket:`#1001`).
-
-
-gaussdb_pool 3.2.4
-^^^^^^^^^^^^^^^^^^
-
-- Add a hint to the warning printed if threads fail to stop during
-  ``__del__``, which has been reported happening during interpreter shutdown
-  on Python 3.13 (see :ticket:`#954`).
-
-
-gaussdb_pool 3.2.3
-^^^^^^^^^^^^^^^^^^
-
-- Add metadata to declare compatibility with Python 3.13.
-
-
-gaussdb_pool 3.2.2
-^^^^^^^^^^^^^^^^^^
-
-- Raise a `RuntimeWarning` instead of a `DeprecationWarning` if an async pool
-  is open in the constructor.
-- Fix connections possibly left in the pool after closing (:ticket:`#784`).
-- Use an empty query instead of ``SELECT 1`` to check connections
-  (:ticket:`#790`).
-
-
-gaussdb_pool 3.2.1
-^^^^^^^^^^^^^^^^^^
-
-- Respect the `!timeout` parameter on `~ConnectionPool.connection()` when
-  `!check` fails. Also avoid a busy-loop of checking; separate check attempts
-  using an exponential backoff (:ticket:`#709`).
-- Use `typing.Self` as a more correct return value annotation of context
-  managers and other self-returning methods (see :ticket:`708`).
-
-
-gaussdb_pool 3.2.0
-------------------
-
-- Add support for async `!reconnect_failed` callbacks in `AsyncConnectionPool`
-  (:ticket:`#520`).
-- Add `!check` parameter to the pool constructor and
-  `~ConnectionPool.check_connection()` method. (:ticket:`#656`).
-- Make connection pool classes generic on the connection type (:ticket:`#559`).
-- Raise a warning if sync pools rely an implicit `!open=True` and the
-  pool context is not used. In the future the default will become `!False`
-  (:ticket:`#659`).
-- Raise a warning if async pools are opened in the constructor. In the future
-  it will become an error. (:ticket:`#659`).
-
-
-gaussdb_pool 3.1.9
-^^^^^^^^^^^^^^^^^^
-
-- Fix the return type annotation of `!NullConnectionPool.__enter__()`
-  (:ticket:`#540`).
-
-
-gaussdb_pool 3.1.8
-^^^^^^^^^^^^^^^^^^
-
-- Enforce connections' ``max_lifetime`` on `~ConnectionPool.check()`
-  (:ticket:`#482`).
-
-
-gaussdb_pool 3.1.7
-^^^^^^^^^^^^^^^^^^
-
-- Fix handling of tasks cancelled while waiting in async pool queue
-  (:ticket:`#503`).
-
-
-gaussdb_pool 3.1.6
-^^^^^^^^^^^^^^^^^^
-
-- Declare all parameters in pools constructors, instead of using `!**kwargs`
-  (:ticket:`#493`).
-
-
-gaussdb_pool 3.1.5
-^^^^^^^^^^^^^^^^^^
-
-- Make sure that `!ConnectionPool.check()` refills an empty pool
-  (:ticket:`#438`).
-- Avoid error in Pyright caused by aliasing `!TypeAlias` (:ticket:`#439`).
-
-
-gaussdb_pool 3.1.4
-^^^^^^^^^^^^^^^^^^
-
-- Fix async pool exhausting connections, happening if the pool is created
-  before the event loop is started (:ticket:`#219`).
-
-
-gaussdb_pool 3.1.3
-^^^^^^^^^^^^^^^^^^
-
-- Add support for Python 3.11 (:ticket:`#305`).
-
-
-gaussdb_pool 3.1.2
-^^^^^^^^^^^^^^^^^^
-
-- Fix possible failure to reconnect after losing connection from the server
-  (:ticket:`#370`).
-
-
-gaussdb_pool 3.1.1
-^^^^^^^^^^^^^^^^^^
-
-- Fix race condition on pool creation which might result in the pool not
-  filling (:ticket:`#230`).
-
-
-gaussdb_pool 3.1.0
-------------------
-
-- Add :ref:`null-pool` (:ticket:`#148`).
-- Add `ConnectionPool.open()` and `!open` parameter to the pool constructor
-  (:ticket:`#151`).
-- Drop support for Python 3.6.
-
-
-gaussdb_pool 3.0.3
-^^^^^^^^^^^^^^^^^^
-
-- Raise `!ValueError` if `ConnectionPool` `!min_size` and `!max_size` are both
-  set to 0 (instead of hanging).
-- Raise `PoolClosed` calling `~ConnectionPool.wait()` on a closed pool.
-
-
-gaussdb_pool 3.0.2
-^^^^^^^^^^^^^^^^^^
-
-- Remove dependency on the internal `!gaussdb._compat` module.
-
-
-gaussdb_pool 3.0.1
-^^^^^^^^^^^^^^^^^^
-
-- Don't leave connections idle in transaction after calling
-  `~ConnectionPool.check()` (:ticket:`#144`).
-
-
-gaussdb_pool 3.0
-----------------
-
 - First release on PyPI.

gaussdb/pyproject.toml

@@ -7,7 +7,7 @@ name = "gaussdb"
 description = "GaussDB database adapter for Python"
 
 # STOP AND READ! if you change:
-version = "1.0.0.dev2"
+version = "1.0.1"
 # also change:
 # - `docs/news.rst` to declare this as the current version or an unreleased one;
 # - `gaussdb_c/pyproject.toml` to the same version;
@@ -48,11 +48,10 @@ email = "[email protected]"
 text = "GNU Lesser General Public License v3 (LGPLv3)"
 
 [project.urls]
-Homepage = "https://psycopg.org/"
-Documentation = "https://psycopg.org/psycopg3/docs/"
-Changes = "https://psycopg.org/psycopg3/docs/news.html"
-Code = "https://github.com/psycopg/psycopg"
-"Issue Tracker" = "https://github.com/psycopg/psycopg/issues"
+Homepage = "https://github.com/HuaweiCloudDeveloper/gaussdb-python/"
+Documentation = "https://github.com/HuaweiCloudDeveloper/gaussdb-python/"
+Code = "https://github.com/HuaweiCloudDeveloper/gaussdb-python/"
+"Issue Tracker" = "https://github.com/HuaweiCloudDeveloper/gaussdb-python/issues"
 
 [project.readme]
 file = "README.rst"

gaussdb_pool/pyproject.toml

@@ -7,7 +7,7 @@ name = "gaussdb-pool"
 description = "Connection Pool for GaussDB"
 
 # STOP AND READ! if you change:
-version = "1.0.0.dev1"
+version = "1.0.1"
 # also change:
 # - `docs/news_pool.rst` to declare this version current or unreleased
 
@@ -44,11 +44,10 @@ email = "[email protected]"
 text = "GNU Lesser General Public License v3 (LGPLv3)"
 
 [project.urls]
-Homepage = "https://psycopg.org/"
-Documentation = "https://www.psycopg.org/psycopg3/docs/advanced/pool.html"
-Changes = "https://psycopg.org/psycopg3/docs/news_pool.html"
-Code = "https://github.com/psycopg/psycopg"
-"Issue Tracker" = "https://github.com/psycopg/psycopg/issues"
+Homepage = "https://github.com/HuaweiCloudDeveloper/gaussdb-python/"
+Documentation = "https://github.com/HuaweiCloudDeveloper/gaussdb-python/"
+Code = "https://github.com/HuaweiCloudDeveloper/gaussdb-python/"
+"Issue Tracker" = "https://github.com/HuaweiCloudDeveloper/gaussdb-python/issues"
 
 [project.readme]
 file = "README.rst"

pyproject.toml

@@ -29,7 +29,6 @@ exclude_lines = [
 files = [
     "gaussdb/gaussdb",
     "gaussdb_pool/gaussdb_pool",
-    "gaussdb_c/gaussdb_c",
     "tests",
 ]
 warn_unused_ignores = true
@@ -57,7 +56,7 @@ disallow_untyped_calls = false
 
 [tool.codespell]
 ignore-words-list = "alot,ans,ba,fo,te,erro,varning"
-skip = "build,_build,.tox,.mypy_cache,.venv,pq.c,_gaussdb.c,*.html"
+skip = "build,_build,.tox,.mypy_cache,.venv,*.html"
 
 [tool.isort]
 profile = "black"