New Coding Style guide

doc/source/coding-style/formatting-tools.rst

@@ -0,0 +1,241 @@
+Code Style Tools
+================
+
+There are plenty of tools for checking code style. This section presents some of
+the most popular ones in the Python ecosystem. A minimum configuration is
+provided for each one so you can easily include them in your PyAnsys project.
+
+Most of the tools presented can be configured using :ref:`the
+\`\`pyproject.toml\`\` file`, avoiding dotfiles and thus leading to a much
+cleaner root project directory.
+
+
+Black
+-----
+`Black`_ is the most popular code formatter in the Python community, as it is
+being maintained by the Python Software Foundation. It allows for a minimum
+configuration to ensure that Python code format looks almost the same across
+projects. 
+
+Unlike `PEP 8`_, the default line length imposed by `black`_ is 88 and not 79
+characters.
+
+The minimum black configuration for a PyAnsys project should look like:
+
+.. code-block:: toml
+
+    [tool.black]
+    line-length: "<length>"
+
+
+Isort
+-----
+The goal of `isort`_  is to properly format ``import`` statements by making sure
+they follow the standard library, third party libraries and custom library
+order.
+
+When using `isort`_ with `black`_, it is important to properly configure both
+tools so no conflicts appear. To do so, make sure you take advantage of the
+``--porfile black`` flag in `isort`_.
+
+.. code-block:: toml
+
+   [tool.isort]
+   profile = "black"
+   force_sort_within_sections = true
+   line_length = "<length>"
+   default_section = "THIRDPARTY"
+   src_paths = ["doc", "src", "tests"]
+
+
+Flake8
+------
+The goal of `flake8` is to act as a `PEP 8`_ compliance checker. Again, it is
+important to make sure that if this tool is being used with `black`_, no
+conflicts arise.
+
+The following configuration is the minimum one to setup `flake8`_ together with
+`black`_ one.
+
+The configuration for `flake8`_ must be specified in a ``.flake8`` file.
+
+.. code-block:: toml
+
+   [flake8]
+   max-line-length = 88
+   extend-ignore = E203
+
+
+Pre-commit
+----------
+To make sure that every commit you made is compliant with the code style
+guidelines of PyAnsys, you can take advantage of `pre-commit`_ in your project.
+Every time you stage some changes and once you commit those, `pre-commit`_ will
+only allow you to do so if all the defined hooks succeedd.
+
+The configuration for `pre-commit`_ must be defined in a
+`.pre-commit-config.yaml` file. The following lines present a minimum
+`pre-commit`_ configuration which includes both code and documentation
+formatting tools.
+
+
+.. code-block:: yaml
+
+    repos:
+
+    - repo: https://github.com/psf/black
+      rev: X.Y.Z
+      hooks:
+      - id: black
+
+    - repo: https://github.com/pycqa/isort
+      rev: X.Y.Z
+      hooks:
+      - id: isort
+
+    - repo: https://github.com/PyCQA/flake8
+      rev: X.Y.Z
+      hooks:
+      - id: flake8
+
+    - repo: https://github.com/codespell-project/codespell
+      rev: vX.Y.Z
+      hooks:
+      - id: codespell
+
+    - repo: https://github.com/pycqa/pydocstyle
+      rev: X.Y.Z
+      hooks:
+      - id: pydocstyle
+        additional_dependencies: [toml]
+        exclude: "tests/"
+
+Installing ``pre-commit``
+~~~~~~~~~~~~~~~~~~~~~~~~~
+You can install ``pre-commit`` by running:
+
+.. code-block:: bash
+
+    python -m pip install pre-commit
+
+Then, make sure you install it as a ``Git hook`` by running:
+
+.. code-block:: bash
+
+    pre-commit install
+
+Using ``pre-commit``
+~~~~~~~~~~~~~~~~~~~~
+From then on, pre-commit will automatically trigger every time you try to commit
+a change. If any of the hooks defined in `.pre-commit-config.yaml` fails, you
+will need to fix the failing files, stage the new changes and try to commit
+those again.
+
+If you want to manually run ``pre-commit``, you can execute:
+
+.. code-block:: bash
+
+    pre-commit run --all-files --show-diff-on-failure
+
+Previous command will show the current and expected style of the code if any of
+the hooks fail.
+
+
+Using ``pre-commit``
+~~~~~~~~~~~~~~~~~~~~
+
+Tox
+---
+A tool you may consider to use in your project is `tox`_. This tool is an
+automation tool similar to `Make`_ but with the advantage of allowing to test
+your package in a temporary virtual environment. This guarantees reproducible
+builds, as your package is no longer tested in "local" mode but in isolated
+form.
+
+Configuration for `tox`_ is stored in a ``tox.ini`` file. The minimum
+configuration for a PyAnsys ``py<product>-<library>`` project should be:
+
+.. 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
+
+
+Previous configuration assumes that you have a ``requirements/`` directory that
+contains a ``requirements_tests.txt`` and a ``requirements_doc.txt``. In
+addition, the ``style`` environment will execute pre-commit, which guarantees
+the usage of this tool in your project.
+
+Installing ``tox``
+~~~~~~~~~~~~~~~~~~
+You can install this tool as any other Python one by running:
+
+.. code-block:: bash
+
+    python -m pip install tox
+
+
+Using ``tox``
+~~~~~~~~~~~~~
+
+The core concept behind `tox`_ are ``environments``. These are similar to
+``Makefile`` rules and highly customizable. Previous configuration ships with
+different environments among which you can find:
+
+- ``style``: for checking the code style of your project.
+- ``py``: which will run your test suite.
+- ``doc``: for building the documentation of your project.
+
+Execute any of the previous environments by running ``tox -e <env-name>``. You
+can run multiple environments by specifying those with commas ``tox -e
+<env-name0>,<env-name1>,...```.  To run all available environments, simply
+execute ``tox``.
+
+
+.. LINKS AND REFERENCES
+
+.. _black: https://black.readthedocs.io/en/latest/
+.. _isort: https://pycqa.github.io/isort/
+.. _flake8: https://flake8.pycqa.org/en/latest/
+.. _pre-commit: https://pre-commit.com/
+.. _tox: https://tox.wiki/en/latest/
+.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
+.. _make: https://www.gnu.org/software/make/

doc/source/coding-style/index.rst

@@ -0,0 +1,29 @@
+Coding Style
+############
+
+Coding Style refers to the different rules defined in a software project which
+need to be followed when writing source code. These guidelines ensure that all
+the source code is going to look the same across the different files of the
+project.
+
+The PyAnsys ecosystem is composed by multiple projects. To unify the coding
+style among all projects, this coding style guideline was devised. 
+
+PyAnsys libraries are expected to follow `PEP 8`_ and be consistent in style and
+formatting with the 'big three' data science libraries: `NumPy`_, `SciPy`_, and
+`pandas`_.
+
+.. toctree::
+   :hidden:
+   :maxdepth: 3
+
+   pep8
+   formatting-tools
+
+
+.. LINKS AND REFERENCES
+
+.. _NumPy: https://numpy.org/
+.. _SciPy: https://www.scipy.org/
+.. _pandas: https://pandas.pydata.org/
+.. _PEP 8: https://www.python.org/dev/peps/pep-0008/