Port modernization changes from pgspecial dbcli/pgspecial#154.

j-bennet · j-bennet · commit d7e6f5cf0ed9 · 2025-04-27T11:21:53.000-07:00
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -8,5 +8,5 @@
 - [ ] I've added this contribution to the `changelog.rst`.
 - [ ] I've added my name to the `AUTHORS` file (or it's already there).
 <!-- We would appreciate if you comply with our code style guidelines. -->
-- [ ] I installed pre-commit hooks (`pip install pre-commit && pre-commit install`), and ran `black` on my code.
+- [ ] I installed pre-commit hooks (`pip install pre-commit && pre-commit install`).
 - [x] Please squash merge this pull request (uncheck if you'd like us to merge as multiple commits)
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -31,10 +31,14 @@ jobs:
           --health-retries 5
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: astral-sh/setup-uv@c7f87aa956e4c323abf06d5dec078e358f6b4d04 # v6.0.0
+        with:
+          version: "latest"
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -68,29 +72,24 @@ jobs:
             psql -h localhost -U postgres -p 6432 pgbouncer -c 'show help'
 
       - name: Install requirements
-        run: |
-          pip install -U pip setuptools
-          pip install --no-cache-dir ".[sshtunnel]"
-          pip install -r requirements-dev.txt
-          pip install keyrings.alt>=3.1
+        run: uv sync --all-extras -p ${{ matrix.python-version }}
 
       - name: Run unit tests
-        run: coverage run --source pgcli -m pytest
+        run: uv run tox -e py${{ matrix.python-version }}
 
       - name: Run integration tests
         env:
             PGUSER: postgres
             PGPASSWORD: postgres
             TERM: xterm
 
-        run: behave tests/features --no-capture
+        run: uv run tox -e integration
 
       - name: Check changelog for ReST compliance
-        run: docutils --halt=warning changelog.rst >/dev/null
+        run: uv run tox -e rest
 
-      - name: Run Black
-        run: black --check .
-        if: matrix.python-version == '3.8'
+      - name: Run style checks
+        run: uv run tox -e style
 
       - name: Coverage
         run: |
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,97 @@
+name: Publish Python Package
+
+on:
+  release:
+    types: [created]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    services:
+      postgres:
+        image: postgres:10
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports:
+            - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: astral-sh/setup-uv@c7f87aa956e4c323abf06d5dec078e358f6b4d04 # v6.0.0
+        with:
+          version: "latest"
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras -p ${{ matrix.python-version }}
+
+      - name: Run unit tests
+        env:
+          LANG: en_US.UTF-8
+        run: uv run tox -e py${{ matrix.python-version }}
+
+      - name: Run Style Checks
+        run: uv run tox -e style
+
+  build:
+    runs-on: ubuntu-latest
+    needs: [test]
+
+    steps:
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+    - uses: astral-sh/setup-uv@c7f87aa956e4c323abf06d5dec078e358f6b4d04 # v6.0.0
+      with:
+        version: "latest"
+
+    - name: Set up Python
+      uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+      with:
+        python-version: '3.13'
+
+    - name: Install dependencies
+      run: uv sync --all-extras -p 3.13
+
+    - name: Build
+      run: uv build
+
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+      with:
+        name: python-packages
+        path: dist/
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: [build]
+    environment: release
+    permissions:
+      id-token: write
+    steps:
+    - name: Download distribution packages
+      uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0
+      with:
+        name: python-packages
+        path: dist/
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # v1.12.4
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,5 +1,10 @@
 repos:
--   repo: https://github.com/psf/black
-    rev: 23.3.0
-    hooks:
-    - id: black
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.11.7
+  hooks:
+    # Run the linter.
+    - id: ruff
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
diff --git a/DEVELOP.rst b/DEVELOP.rst
@@ -23,8 +23,8 @@ repo.
    $ git remote add upstream git@github.com:dbcli/pgcli.git
 
 Once the 'upstream' end point is added you can then periodically do a ``git
-pull upstream master`` to update your local copy and then do a ``git push
-origin master`` to keep your own fork up to date.
+pull upstream main`` to update your local copy and then do a ``git push
+origin main`` to keep your own fork up to date.
 
 Check Github's `Understanding the GitHub flow guide
 <https://guides.github.com/introduction/flow/>`_ for a more detailed
@@ -38,30 +38,23 @@ pgcli. If you're developing pgcli, you'll need to install it in a slightly
 different way so you can see the effects of your changes right away without
 having to go through the install cycle every time you change the code.
 
-It is highly recommended to use virtualenv for development. If you don't know
-what a virtualenv is, `this guide <http://docs.python-guide.org/en/latest/dev/virtualenvs/#virtual-environments>`_
-will help you get started.
-
-Create a virtualenv (let's call it pgcli-dev). Activate it:
+Set up [uv](https://docs.astral.sh/uv/getting-started/installation/) for development:
 
 ::
 
+    cd pgcli
+    uv venv
     source ./pgcli-dev/bin/activate
 
-    or
-
-    .\pgcli-dev\scripts\activate (for Windows)
-
-Once the virtualenv is activated, `cd` into the local clone of pgcli folder
-and install pgcli using pip as follows:
+Once the virtualenv is activated, install pgcli using pip as follows:
 
 ::
 
-    $ pip install --editable .
+    $ uv pip install --editable .
 
     or
 
-    $ pip install -e .
+    $ uv pip install -e .
 
 This will install the necessary dependencies as well as install pgcli from the
 working folder into the virtualenv. By installing it using `pip install -e`
@@ -165,9 +158,8 @@ in the ``tests`` directory.  An example::
 First, install the requirements for testing:
 
 ::
-    $ pip install -U pip setuptools 
     $ pip install --no-cache-dir ".[sshtunnel]" 
-    $ pip install -r requirements-dev.txt 
+    $ pip install --no-cache-dir ".[dev]"
 
 Ensure that the database user has permissions to create and drop test databases
 by checking your ``pg_hba.conf`` file. The default user should be ``postgres``
@@ -180,20 +172,14 @@ service for the changes to take effect.
     # ONLY IF YOU MADE CHANGES TO YOUR pg_hba.conf FILE
     $ sudo service postgresql restart
 
-After that, tests in the ``/pgcli/tests`` directory can be run with:
-(Note that these ``behave`` tests do not currently work when developing on Windows due to pexpect incompatibility.)
+After that:
 
 ::
 
-    # on directory /pgcli/tests
+    $ cd pgcli/tests
     $ behave
 
-And on the ``/pgcli`` directory:
-
-::
-
-    # on directory /pgcli
-    $ py.test
+Note that these ``behave`` tests do not currently work when developing on Windows due to pexpect incompatibility.
 
 To see stdout/stderr, use the following command:
 
@@ -209,10 +195,21 @@ Troubleshooting the integration tests
 - Check `this issue <https://github.com/dbcli/pgcli/issues/945>`_ for relevant information.
 - `File an issue <https://github.com/dbcli/pgcli/issues/new>`_.
 
+Running the unit tests
+----------------------
+
+The unit tests can be run with pytest:
+
+::
+
+    $ cd pgcli
+    $ pytest
+
+
 Coding Style
 ------------
 
-``pgcli`` uses `black <https://github.com/ambv/black>`_ to format the source code. Make sure to install black.
+``pgcli`` uses `ruff <https://github.com/astral-sh/ruff>`_ to format the source code.
 
 Releases
 --------
diff --git a/RELEASES.md b/RELEASES.md
@@ -1,24 +1,6 @@
 Releasing pgcli
 ---------------
 
-You have been made the maintainer of `pgcli`? Congratulations! We have a release script to help you:
+You have been made the maintainer of `pgcli`? Congratulations!
 
-```sh
-> python release.py --help
-Usage: release.py [options]
-
-Options:
-  -h, --help           show this help message and exit
-  -c, --confirm-steps  Confirm every step. If the step is not confirmed, it
-                       will be skipped.
-  -d, --dry-run        Print out, but not actually run any steps.
-```
-
-The script can be run with `-c` to confirm or skip steps. There's also a `--dry-run` option that only prints out the steps.
-
-To release a new version of the package:
-
-* Create and merge a PR to bump the version in the changelog ([example PR](https://github.com/dbcli/pgcli/pull/1325)).
-* Pull `main` and bump the version number inside `pgcli/__init__.py`. Do not check in - the release script will do that.
-* Make sure you have the dev requirements installed: `pip install -r requirements-dev.txt -U --upgrade-strategy only-if-needed`.
-* Finally, run the release script: `python release.py`.
+To release a new version of the package, [create a new release](https://github.com/dbcli/pgcli/releases) in Github. This will trigger a Github action which will run all the tests, build the wheel and upload it to PyPI.
diff --git a/pyproject.toml b/pyproject.toml
@@ -51,11 +51,26 @@ pgcli = "pgcli.main:cli"
 [project.optional-dependencies]
 keyring = ["keyring >= 12.2.0"]
 sshtunnel = ["sshtunnel >= 0.4.0"]
+dev = [
+    "pytest>=2.7.0",
+    "tox>=1.9.2",
+    "behave>=1.2.4",
+    "pexpect==3.3; platform_system != 'Windows'",
+    "pre-commit>=1.16.0",
+    "coverage>=5.0.4",
+    "codecov>=1.5.1",
+    "docutils>=0.13.1",
+    "ruff>=0.11.7",
+    "sshtunnel>=0.4.0",
+    "build<0.10.0",
+]
 
 [build-system]
-requires = ["setuptools>=61.2"]
+requires = ["setuptools>=64.0", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools_scm]
+
 [tool.setuptools]
 include-package-data = false
 
@@ -68,24 +83,15 @@ find = { namespaces = false }
 [tool.setuptools.package-data]
 pgcli = ["pgclirc", "packages/pgliterals/pgliterals.json"]
 
-[tool.black]
-line-length = 88
-target-version = ['py38']
-include = '\.pyi?$'
-exclude = '''
-/(
-    \.eggs
-  | \.git
-  | \.hg
-  | \.mypy_cache
-  | \.tox
-  | \.venv
-  | \.cache
-  | \.pytest_cache
-  | _build
-  | buck-out
-  | build
-  | dist
-  | tests/data
-)/
-'''
+[tool.ruff]
+target-version = 'py39'
+line-length = 140
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+known-first-party = ['pgcli', 'tests']
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "--capture=sys --showlocals -rxs"
+testpaths = ["tests"]
diff --git a/requirements-dev.txt b/requirements-dev.txt
diff --git a/tox.ini b/tox.ini
