maint: badges, version and various improvements (#33)

Author: RobPasMue

.github/workflows/ci_cd.yml

@@ -27,16 +27,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check branch name
-        uses: ansys/actions/branch-name-style@main
-
-  style:
-    name: Code style
-    runs-on: ubuntu-latest
-    steps:
-      - name: PyAnsys code style checks
-        uses: ansys/actions/code-style@v6
-        with:
-          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+        uses: ansys/actions/branch-name-style@v6
 
   docs-style:
     name: Documentation Style Check
@@ -57,14 +48,10 @@ jobs:
 
     - name: "Run Ansys documentation building action"
       uses: ansys/actions/doc-build@v6
-      with:
-        TODO: remove once public
-        check-links: false
 
   smoke-tests:
     name: Build and Smoke tests
     runs-on: ${{ matrix.os }}
-    needs: [style]
     strategy:
       fail-fast: false
       matrix:
@@ -87,7 +74,6 @@ jobs:
     name: Run Unit Tests
     needs: [ smoke-tests ]
     runs-on: ubuntu-latest
-
     steps:
       - name: Restore images cache
         uses: actions/cache@v4
@@ -142,12 +128,12 @@ jobs:
     needs: [package]
     runs-on: ubuntu-latest
     steps:
-      #- name: Release to the public PyPI repository
-        #uses: ansys/actions/release-pypi-public@v5
-        #with:
-        #  library-name: ${{ env.PACKAGE_NAME }}
-        #  twine-username: "__token__"
-        #  twine-token: ${{ secrets.PYPI_TOKEN }}
+      - name: Release to the public PyPI repository
+        uses: ansys/actions/release-pypi-public@v6
+        with:
+         library-name: ${{ env.PACKAGE_NAME }}
+         twine-username: "__token__"
+         twine-token: ${{ secrets.PYPI_TOKEN }}
 
       - name: Release to GitHub
         uses: ansys/actions/release-github@v6

README.rst

@@ -1,15 +1,31 @@
 Visualization Interface Tool
 ============================
-|pyansys| |MIT|
+|pyansys| |python| |pypi| |MIT| |GH-CI| |pre-commit|
 
 .. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
    :target: https://docs.pyansys.com/
    :alt: PyAnsys
 
+.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-tools-visualization-interface?logo=pypi
+   :target: https://pypi.org/project/ansys-tools-visualization-interface/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/ansys-tools-visualization-interface.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/ansys-tools-visualization-interface
+   :alt: PyPI
+
 .. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
    :target: https://opensource.org/licenses/MIT
    :alt: MIT
 
+.. |GH-CI| image:: https://github.com/ansys/ansys-tools-visualization-interface/actions/workflows/ci_cd.yml/badge.svg
+   :target: https://github.com/ansys/ansys-tools-visualization-interface/actions/workflows/ci_cd.yml
+   :alt: GH-CI
+
+.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/ansys-tools-visualization-interface/main.svg
+   :target: https://results.pre-commit.ci/latest/github/ansys/ansys-tools-visualization-interface/main
+   :alt: pre-commit.ci status
+
 .. contents::
 
 Overview

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "ansys-tools-visualization-interface"
-version = "0.1.dev0"
+version = "0.2.dev0"
 description = "A Python visualization interface for PyAnsys libraries"
 readme = "README.rst"
 requires-python = ">=3.9,<4"
@@ -22,7 +22,6 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
 ]
-
 dependencies = [
     "pyvista >= 0.42.0,<1",
     "beartype >= 0.17.0,<1",
@@ -33,13 +32,7 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-
-tests = [
-    "pytest==8.2.0",
-    "pytest-pyvista==0.1.9",
-    "pytest-cov==5.0.0",
-]
-
+tests = ["pytest==8.2.0", "pytest-pyvista==0.1.9", "pytest-cov==5.0.0"]
 doc = [
     "ansys-sphinx-theme==0.15.2",
     "jupyter_sphinx==0.5.3",
@@ -59,7 +52,6 @@ name = "ansys.tools.visualization_interface"
 
 [tool.black]
 line-length = 100
-indent-width = 4
 
 [tool.isort]
 profile = "black"
@@ -73,30 +65,24 @@ addopts = "-ra --cov=ansys.tools.visualization_interface --cov-report html:.cov/
 
 [tool.ruff]
 line-length = 120
-extend-exclude = [
-    "examples/**/*.py",
-]
+extend-exclude = ["examples/**/*.py"]
 
 [tool.ruff.lint]
 select = [
-    "E",    # pycodestyle, see https://beta.ruff.rs/docs/rules/#pycodestyle-e-w
-    "D",    # pydocstyle, see https://beta.ruff.rs/docs/rules/#pydocstyle-d
-    "F",    # pyflakes, see https://beta.ruff.rs/docs/rules/#pyflakes-f
-    "I",    # isort, see https://beta.ruff.rs/docs/rules/#isort-i
-    "N",    # pep8-naming, see https://beta.ruff.rs/docs/rules/#pep8-naming-n
-    "PTH",  # flake8-use-pathlib, https://beta.ruff.rs/docs/rules/#flake8-use-pathlib-pth
+    "E",   # pycodestyle, see https://beta.ruff.rs/docs/rules/#pycodestyle-e-w
+    "D",   # pydocstyle, see https://beta.ruff.rs/docs/rules/#pydocstyle-d
+    "F",   # pyflakes, see https://beta.ruff.rs/docs/rules/#pyflakes-f
+    "I",   # isort, see https://beta.ruff.rs/docs/rules/#isort-i
+    "N",   # pep8-naming, see https://beta.ruff.rs/docs/rules/#pep8-naming-n
+    "PTH", # flake8-use-pathlib, https://beta.ruff.rs/docs/rules/#flake8-use-pathlib-pth
 ]
-ignore = [
-    "D416",
-]
-
+ignore = ["D416"]
 
 [tool.ruff.format]
 quote-style = "double"
 indent-style = "tab"
 line-ending = "auto"
 
-
 [tool.ruff.lint.isort]
 combine-as-imports = true
 force-sort-within-sections = true
@@ -105,4 +91,3 @@ known-first-party = ["ansys"]
 [tool.ruff.lint.pydocstyle]
 # Settings: https://docs.astral.sh/ruff/settings/#lintpydocstyle
 convention = "google"
-