New Coding Style guide

doc/source/abstractions/app-interface.rst

@@ -61,45 +61,49 @@ within this method.
 
 .. code:: python
 
-    def create_open_region(self, frequency="1GHz", boundary="Radiation",
-                           apply_infinite_gp=False, gp_axis="-z"):
-       """Create an open region on the active editor.
-
-       Parameters
-       ----------
-       frequency : str, optional
-           Frequency with units. The  default is ``"1GHz"``.
-       boundary : str, optional
-           Type of the boundary. The default is ``"Radiation"``.
-       apply_infinite_gp : bool, optional
-           Whether to apply an infinite ground plane. The default is ``False``.
-       gp_axis : str, optional
-           The default is ``"-z"``.
-
-       Returns
-       -------
-       bool
-           ``True`` when successful, ``False`` when failed.
-
-       Examples
-       --------
-       Create an open region in the active editor at 1 GHz.
-
-       >>> hfss.create_open_region(frequency="1GHz")
-
-       """
-       vars = [
-           "NAME:Settings",
-           "OpFreq:=", frequency,
-           "Boundary:=", boundary,
-           "ApplyInfiniteGP:=", apply_infinite_gp
-       ]
-       if apply_infinite_gp:
-           vars.append("Direction:=")
-           vars.append(gp_axis)
-
-       self._omodelsetup.CreateOpenRegion(vars)
-       return True
+    def create_open_region(
+        self, frequency="1GHz", boundary="Radiation", apply_infinite_gp=False, gp_axis="-z"
+    ):
+        """Create an open region in the active editor.
+
+        Parameters
+        ----------
+        frequency : str, optional
+            Frequency with units. The  default is ``"1GHz"``.
+        boundary : str, optional
+            Type of the boundary. The default is ``"Radiation"``.
+        apply_infinite_gp : bool, optional
+            Whether to apply an infinite ground plane. The default is ``False``.
+        gp_axis : str, optional
+            The default is ``"-z"``.
+
+        Returns
+        -------
+        bool
+            ``True`` when successful, ``False`` when failed.
+
+        Examples
+        --------
+        Create an open region in the active editor at 1 GHz.
+
+        >>> hfss.create_open_region(frequency="1GHz")
+
+        """
+        vars = [
+            "NAME:Settings",
+            "OpFreq:=",
+            frequency,
+            "Boundary:=",
+            boundary,
+            "ApplyInfiniteGP:=",
+            apply_infinite_gp,
+        ]
+        if apply_infinite_gp:
+            vars.append("Direction:=")
+            vars.append(gp_axis)
+
+        self._omodelsetup.CreateOpenRegion(vars)
+        return True
 
 Here, the COM ``CreateOpenRegion`` method is abstracted, encapsulating
 the model setup object.  There's no reason why a user needs direct

doc/source/coding-style/code/tox-flit.rst

@@ -0,0 +1,43 @@
+.. code-block:: ini
+
+    [tox]
+    description = Default tox environments list
+    envlist =
+        style,{py37,py38,py39,py310}{,-coverage},doc
+    skip_missing_interpreters = true
+    isolated_build = true
+    isolated_build_env = build
+
+    [testenv]
+    description = Checks for project unit tests and coverage (if desired)
+    basepython =
+        py37: python3.7
+        py38: python3.8
+        py39: python3.9
+        py310: python3.10
+        py: python3
+        {style,reformat,doc,build}: python3
+    setenv =
+        PYTHONUNBUFFERED = yes
+        coverage: PYTEST_EXTRA_ARGS = --cov=ansys.product --cov-report=term --cov-report=xml --cov-report=html
+    deps =
+        -r{toxinidir}/requirements/requirements_tests.txt
+    commands =
+        pytest {env:PYTEST_MARKERS:} {env:PYTEST_EXTRA_ARGS:} {posargs:-vv}
+
+    [testenv:style]
+    description = Checks project code style
+    skip_install = true
+    deps =
+        pre-commit
+    commands =
+        pre-commit install
+        pre-commit run --all-files --show-diff-on-failure
+
+    [testenv:doc]
+    description = Check if documentation generates properly
+    deps =
+        -r{toxinidir}/requirements/requirements_doc.txt
+    commands =
+        sphinx-build -d "{toxworkdir}/doc_doctree" doc/source "{toxworkdir}/doc_out" --color -vW -bhtml
+

doc/source/coding-style/code/tox-poetry.rst

@@ -0,0 +1,46 @@
+.. code-block:: ini
+
+    [tox]
+    description = Default tox environments list
+    envlist =
+        style,{py37,py38,py39,py310}{,-coverage},doc
+    skip_missing_interpreters = true
+    isolated_build = true
+
+    [testenv]
+    description = Checks for project unit tests and coverage (if desired)
+    basepython =
+        py37: python3.7
+        py38: python3.8
+        py39: python3.9
+        py310: python3.10
+        py: python3
+        {style,reformat,doc,build}: python3
+    skip_install = true
+    whitelist_externals = 
+        poetry
+    setenv =
+        PYTHONUNBUFFERED = yes
+        coverage: PYTEST_EXTRA_ARGS = --cov=ansys.product --cov-report=term --cov-report=xml --cov-report=html
+    deps =
+        -r{toxinidir}/requirements/requirements_tests.txt
+    commands =
+        poetry install
+        poetry run pytest {env:PYTEST_MARKERS:} {env:PYTEST_EXTRA_ARGS:} {posargs:-vv}
+
+    [testenv:style]
+    description = Checks project code style
+    skip_install = true
+    deps =
+        pre-commit
+    commands =
+        pre-commit install
+        pre-commit run --all-files --show-diff-on-failure
+
+    [testenv:doc]
+    description = Check if documentation generates properly
+    deps =
+        -r{toxinidir}/requirements/requirements_doc.txt
+    commands =
+        poetry run sphinx-build -d "{toxworkdir}/doc_doctree" doc/source "{toxworkdir}/doc_out" --color -vW -bhtml
+