Add pre-commit configuration (#11)

* Add pre-commit configuration

* Update src/ansys/product/library/other_module.py

Co-authored-by: Maxime Rey <[email protected]>

* Use 'poetry install' instead of 'pip install' to get pinned dependencies

Co-authored-by: Maxime Rey <[email protected]>

Author: greschd

.github/workflows/ci_cd.yml

@@ -12,7 +12,7 @@ on:
 
 jobs:
   style:
-    name: Style Check
+    name: Pre-commit Check
     runs-on: ubuntu-latest
 
     steps:
@@ -22,17 +22,14 @@ jobs:
         with:
           python-version: 3.8
 
-      - name: Install style requirements
+      - name: Install pre-commit requirements
         run: |
-          pip install .[style] --disable-pip-version-check
+          pip install poetry
+          poetry install -E pre-commit
 
-      - name: Codespell
+      - name: Run pre-commit
         run: |
-          make codespell
-
-      - name: flake8
-        run: |
-          make flake8
+          poetry run pre-commit run --all-files || ( git status --short ; git diff ; exit 1 )
 
   main:
     name: Build and Testing
@@ -82,17 +79,19 @@ jobs:
           python-version: 3.8
 
       - name: Install library, with docs extra
-        run: pip install .[docs]
+        run: |
+          pip install poetry
+          poetry install -E docs
 
       - name: Build HTML
         run: |
-          make -C doc html SPHINXOPTS="-W"
+          poetry run make -C doc html SPHINXOPTS="-W"
 
       - name: Build PDF Documentation
         run: |
           sudo apt update
           sudo apt-get install -y texlive-latex-extra latexmk
-          make -C doc latexpdf
+          poetry run make -C doc latexpdf
 
       - name: Upload HTML Documentation
         uses: actions/upload-artifact@v2

.pre-commit-config.yaml

@@ -0,0 +1,33 @@
+repos:
+- repo: https://github.com/psf/black
+  rev: 22.1.0
+  hooks:
+  - id: black
+- repo: https://github.com/asottile/reorder_python_imports
+  rev: v2.7.1
+  hooks:
+  - id: reorder-python-imports
+    args: ["--py37-plus"]
+- repo: https://gitlab.com/PyCQA/flake8
+  rev: 3.9.2
+  hooks:
+  - id: flake8
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.1.0
+  hooks:
+  - id: codespell
+# - repo: https://github.com/pycqa/pydocstyle
+#   rev: 6.1.1
+#   hooks:
+#   - id: pydocstyle
+#     additional_dependencies: [toml]
+- repo: local
+  hooks:
+  - id: mypy
+    name: mypy
+    entry: mypy
+    language: python
+    types: [python]
+    require_serial: true
+    exclude: "^(doc/)|(tests/)|(dist/)"
+    args: []

doc/source/conf.py

@@ -1,30 +1,29 @@
 """Sphinx documentation configuration file."""
 from datetime import datetime
 
-from pyansys_sphinx_theme import pyansys_logo_black
-
 from ansys.product.library import __version__
+from pyansys_sphinx_theme import pyansys_logo_black
 
 # Project information
-project = 'ansys-product-library'
+project = "ansys-product-library"
 copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved"
 author = "Ansys Inc."
 release = version = __version__
 
 # use the default pyansys logo
 html_logo = pyansys_logo_black
-html_theme = 'pyansys_sphinx_theme'
+html_theme = "pyansys_sphinx_theme"
 
 # specify the location of your github repo
 html_theme_options = {
     "github_url": "https://github.com/pyansys/pyansys-sphinx-theme",
-    "show_prev_next": False
+    "show_prev_next": False,
 }
 
 # Sphinx extensions
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
     "numpydoc",
     "sphinx.ext.intersphinx",
     "sphinx_copybutton",
@@ -33,9 +32,7 @@
 # Intersphinx mapping
 intersphinx_mapping = {
     "python": ("https://docs.python.org/dev", None),
-
     # kept here as an example
-
     # "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
     # "numpy": ("https://numpy.org/devdocs", None),
     # "matplotlib": ("https://matplotlib.org/stable", None),
@@ -73,7 +70,7 @@
 templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"