fix(ci): use pyproject and ruff

Author: jourdain

.github/workflows/test_and_release.yml

@@ -10,9 +10,9 @@ jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.9"
 
@@ -28,7 +28,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.9]
+        python-version: ["3.9"]
         config:
         - {
             name: "Linux",
@@ -49,17 +49,22 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 
     - name: Install OSMesa for Linux
       if: matrix.config.os == 'ubuntu-latest'
       run: sudo apt-get install -y libosmesa6-dev
 
+    - name: Set Up Node
+      uses: actions/setup-node@v4
+      with:
+        node-version: 18
+
     - name: Build Vue Components
       run: |
         cd vue-components
@@ -79,12 +84,12 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Set Up Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 14
+          node-version: 18
 
       - name: Build Vue Components
         run: |
@@ -100,17 +105,23 @@ jobs:
     ]
     runs-on: ubuntu-latest
     if: github.event_name == 'push'
+    environment:
+      name: pypi
+      url: https://pypi.org/p/trame-rca
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+      contents: write # IMPORTANT: mandatory for making GitHub Releases
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Set Up Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 14
+          node-version: 18
 
       - name: Build Vue Components
         run: |
@@ -119,8 +130,11 @@ jobs:
           npm run build
 
       - name: Python Semantic Release
-        uses: relekang/[email protected]
+        id: release
+        uses: relekang/[email protected]
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          repository_username: __token__
-          repository_password: ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Publish package distributions to PyPI
+        if: steps.release.outputs.released == 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1

.pre-commit-config.yaml

@@ -1,16 +1,11 @@
 repos:
-  - repo: https://github.com/psf/black
-    rev: 22.3.0
-    hooks:
-      - id: black
-        entry: black --check
-
   - repo: https://github.com/codespell-project/codespell
     rev: v2.1.0
     hooks:
       - id: codespell
 
-  - repo: https://github.com/PyCQA/flake8
-    rev: 4.0.1
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
     hooks:
-      - id: flake8
+      - id: ruff
+      - id: ruff-format

CONTRIBUTING.rst

@@ -1,6 +1,6 @@
-=========================
+==========================================
 Contributing to trame-rca
-=========================
+==========================================
 
 #. Clone the repository using ``git clone``
 #. Install pre-commit via ``pip install pre-commit``
@@ -13,7 +13,6 @@ Tips
 ####
 
 #. When first creating a new project, it is helpful to run ``pre-commit run --all-files`` to ensure all files pass the pre-commit checks.
-#. A quick way to fix ``black`` issues is by installing black (``pip install black``) and running the ``black`` command at the root of your repository.
-#. Sometimes, ``black`` and ``flake8`` do not agree. Add options to your ``.flake8`` file to fix these things. See the `flake8 configuration docs <https://flake8.pycqa.org/en/latest/user/configuration.html>`_ for more details.
+#. A quick way to fix ``ruff`` issues is by installing ruff (``pip install ruff``) and running the ``ruff check --fix .`` or ``ruff format`` command at the root of your repository.
 #. A quick way to fix ``codespell`` issues is by installing codespell (``pip install codespell``) and running the ``codespell -w`` command at the root of your directory.
-#. The `.codespellrc file <https://github.com/codespell-project/codespell#using-a-config-file>`_ can be used fix any other codespell issues, such as ignoring certain files, directories, words, or regular expressions.
+#. The `.codespellrc file <https://github.com/codespell-project/codespell#using-a-config-file>`_ can be used fix any other codespell issues, such as ignoring certain files, directories, words, or regular expressions.

MANIFEST.in

@@ -1 +1,5 @@
 graft trame_rca/module/serve
+prune examples
+prune js-lib
+prune tests
+prune vue-components

pyproject.toml

@@ -0,0 +1,86 @@
+[project]
+name = "trame-rca"
+version = "0.7.0"
+description = "Remote Controlled Area widget for trame"
+authors = [
+    {name = "Kitware Inc."},
+]
+dependencies = [
+    "trame-client>=3.4,<4",
+    "wslink>=2.1.3",
+]
+requires-python = ">=3.9"
+readme = "README.rst"
+license = {text = "Apache License 2.0"}
+keywords = ["Python", "Interactive", "Web", "Application", "Framework"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pre-commit",
+    "ruff",
+    "pytest",
+]
+
+[build-system]
+requires = ['setuptools', 'wheel']
+build-backend = 'setuptools.build_meta'
+
+[tool.setuptools.packages.find]
+where = ["."]
+
+[tool.setuptools.package-data]
+
+
+[tool.semantic_release]
+version_toml = [
+    "pyproject.toml:project.version",
+]
+build_command = """
+  python -m venv .venv
+  source .venv/bin/activate
+  pip install -U pip build
+  python -m build .
+"""
+
+[semantic_release.publish]
+dist_glob_patterns = ["dist/*"]
+upload_to_vcs_release = true
+
+[tool.ruff]
+line-length = 88
+indent-width = 4
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "W", "F"]
+ignore = []
+fixable = ["ALL"]
+unfixable = []
+
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+docstring-code-format = true
+
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+
+[tool.ruff.lint.pycodestyle]
+max-line-length = 120
+
+[lint.pydocstyle]
+convention = "google"

setup.cfg

@@ -1 +1 @@
-from trame_rca.module import *
+from trame_rca.module import *  # noqa: F403

setup.py

@@ -1,4 +1,4 @@
-from trame_rca.widgets.rca import *
+from trame_rca.widgets.rca import *  # noqa: F403
 
 
 def initialize(server):

trame/modules/rca.py

@@ -32,7 +32,11 @@ def on_interaction(self, origin, event):
         modifier_fn = event.get("fn", 0)
         print(f"{origin}::{event_type}: {position}")
         print(
-            f"Modifier: shift({modifier_shift}), ctrl({modifier_ctrl}), alt({modifier_alt}), command({modifier_cmd}), fn({modifier_fn})"
+            f"Modifier: shift({modifier_shift}), "
+            f"ctrl({modifier_ctrl}), "
+            f"alt({modifier_alt}), "
+            f"command({modifier_cmd}), "
+            f"fn({modifier_fn})"
         )
 
 

trame/widgets/rca.py

@@ -1,5 +1,5 @@
-"""RCA Widgets only support vue2 for now.
-"""
+"""RCA Widgets only support vue2 for now."""
+
 from trame_client.widgets.core import AbstractElement
 from .. import module