ansys-pre-commit-hooks 0.3.2__tar.gz → 0.4.1__tar.gz

ansys_pre_commit_hooks-0.4.1/AUTHORS.md

@@ -0,0 +1,12 @@
+# This is the list of ansys-pre-commit-hooks's significant contributors.
+#
+# This file does not necessarily list everyone who has contributed code.
+#
+# For contributions made under a Corporate CLA, the organization is
+# added to this file.
+#
+# If you have contributed to the repository and wish to be added to this file
+# please submit a request.
+#
+#
+ANSYS, Inc.

ansys_pre_commit_hooks-0.4.1/MANIFEST.in

@@ -0,0 +1,2 @@
+# MANIFEST.in
+graft src/ansys/pre_commit_hooks

ansys_pre_commit_hooks-0.3.2/README.rst → ansys_pre_commit_hooks-0.4.1/PKG-INFO

@@ -1,3 +1,46 @@
+Metadata-Version: 2.1
+Name: ansys-pre-commit-hooks
+Version: 0.4.1
+Summary: A Python wrapper to create Ansys-tailored pre-commit hooks
+Home-page: https://github.com/ansys/pre-commit-hooks
+Author: ANSYS, Inc.
+Author-email: pyansys.core@ansys.com
+Maintainer: ANSYS, Inc.
+Maintainer-email: pyansys.core@ansys.com
+License: MIT
+Project-URL: Source, https://github.com/ansys/pre-commit-hooks/
+Project-URL: Tracker, https://github.com/ansys/pre-commit-hooks/issues
+Project-URL: Homepage, https://github.com/ansys/pre-commit-hooks
+Project-URL: Documentation, https://pre-commit-hooks.docs.pyansys.com
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9,<4
+License-File: LICENSE
+License-File: AUTHORS.md
+Requires-Dist: GitPython==3.1.43
+Requires-Dist: importlib-metadata==8.0.0
+Requires-Dist: Jinja2==3.1.4
+Requires-Dist: reuse==3.0.2
+Requires-Dist: requests==2.32.3
+Requires-Dist: semver==3.0.2
+Requires-Dist: toml==0.10.2
+Provides-Extra: doc
+Requires-Dist: ansys-sphinx-theme[autoapi]==0.16.6; extra == "doc"
+Requires-Dist: numpydoc==1.7.0; extra == "doc"
+Requires-Dist: sphinx==7.4.0; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==2.2.2; extra == "doc"
+Requires-Dist: sphinx-copybutton==0.5.1; extra == "doc"
+Provides-Extra: tests
+Requires-Dist: pytest==8.2.2; extra == "tests"
+Requires-Dist: pytest-cov==5.0.0; extra == "tests"
+
 Ansys pre-commit hooks
 ======================
 |pyansys| |python| |pypi| |GH-CI| |MIT| |black| |pre-commit-ci|
@@ -36,8 +79,8 @@ Currently, these hooks are available:
 * ``add-license-headers``: Add missing license headers to files by using
   `REUSE <https://reuse.software/>`_ . To use this hook, you must
   have ``REUSE`` implemented in your repository.
-
-|
+* ``tech-review``: Do a technical review of your repository according to
+  `Ansys repository requirements <https://dev.docs.pyansys.com/packaging/structure.html>`_`
 
 ``add-license-headers`` setup
 -----------------------------
@@ -84,7 +127,7 @@ Set custom arguments
 .. code:: yaml
 
    - repo: https://github.com/ansys/pre-commit-hooks
-   rev: v0.3.2
+   rev: v0.4.1
    hooks:
    - id: add-license-headers
      args: ["--custom_copyright", "custom copyright phrase", "--custom_template", "template_name", "--custom_license", "license_name", "--ignore_license_check", "--start_year", "2023"]
@@ -129,7 +172,7 @@ the hook should run on, add the necessary regex to the ``files`` line in your
 .. code:: yaml
 
    - repo: https://github.com/ansys/pre-commit-hooks
-     rev: v0.3.2
+     rev: v0.4.1
      hooks:
      - id: add-license-headers
        files: '(src|examples|tests|newFolder)/.*\.(py|newExtension)|\.(proto|newExtension)'
@@ -142,7 +185,7 @@ In .pre-commit-config.yaml:
 .. code:: yaml
 
   - repo: https://github.com/ansys/pre-commit-hooks
-    rev: v0.3.2
+    rev: v0.4.1
     hooks:
     - id: add-license-headers
       exclude: |
@@ -160,6 +203,59 @@ In .pre-commit-config.yaml:
 * ``.*\.js`` excludes all .js files in all directories.
 * ``\..*`` excludes all hidden files.
 
+``tech-review`` setup
+---------------------
+
+These are the default values for the arguments of the tech-review hook:
+
+* ``--author_maint_name=ANSYS, Inc.``
+* ``--author_maint_email=pyansys.core@ansys.com``
+* ``--license=MIT``
+* ``--url=https://github.com/ansys/{repo-name}``, replacing ``repo-name`` with the name of the repository
+
+The ``--author_maint_name`` is the name of the author and maintainer in the ``pyproject.toml`` file.
+By default, it is "Ansys, Inc.".
+
+The ``--author_maint_email`` is the email of the author and maintainer in the ``pyproject.toml`` file.
+By default, it is "pyansys.core@ansys.com".
+
+The ``--license`` argument is the license that is being used by your repository. By default, it is
+MIT.
+
+The ``--url`` argument is automatically rendered based on the repository name. If your repository
+is not in the Ansys organization, please add this argument to your configuration in
+.pre-commit-config.yaml.
+
+The ``--product`` argument is required if a ``README.rst`` or ``README.md`` file does not
+exist in your repository and you want the template to render correctly. The product
+for ``PyMechanical`` would be ``mechanical``, for example.
+
+The ``--non_compliant_name`` flag can be used if your repository does not follow the typical
+naming convention of ``ansys-*-*``.
+
+Technical review hook in ``ansys/pre-commit-hooks``' .pre-commit-config.yaml file:
+
+.. code:: yaml
+
+  - repo: https://github.com/ansys/pre-commit-hooks
+    rev: v0.4.1
+    hooks:
+    - id: tech-review
+      args:
+      - --product=pre_commit_hooks
+      - --non_compliant_name
+
+Technical review hook in ``PyMechanical``'s .pre-commit-config.yaml file:
+
+.. code:: yaml
+
+  - repo: https://github.com/ansys/pre-commit-hooks
+    rev: v0.4.1
+    hooks:
+    - id: tech-review
+      args:
+      - --product=mechanical
+
 
 How to install
 --------------

ansys_pre_commit_hooks-0.3.2/PKG-INFO → ansys_pre_commit_hooks-0.4.1/README.rst

@@ -1,35 +1,3 @@
-Metadata-Version: 2.1
-Name: ansys-pre-commit-hooks
-Version: 0.3.2
-Summary: A Python wrapper to create Ansys-tailored pre-commit hooks
-Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
-Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
-Requires-Python: >=3.9,<4
-Description-Content-Type: text/x-rst
-Classifier: Development Status :: 4 - Beta
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Dist: importlib-metadata==7.1.0
-Requires-Dist: reuse==3.0.2
-Requires-Dist: GitPython==3.1.43
-Requires-Dist: ansys-sphinx-theme[autoapi]==0.16.5 ; extra == "doc"
-Requires-Dist: numpydoc==1.7.0 ; extra == "doc"
-Requires-Dist: sphinx==7.3.7 ; extra == "doc"
-Requires-Dist: sphinx-autodoc-typehints==2.1.1 ; extra == "doc"
-Requires-Dist: sphinx-copybutton==0.5.1 ; extra == "doc"
-Requires-Dist: pytest==8.2.2 ; extra == "tests"
-Requires-Dist: pytest-cov==5.0.0 ; extra == "tests"
-Project-URL: Documentation, https://pre-commit-hooks.docs.ansys.com
-Project-URL: Homepage, https://github.com/ansys/pre-commit-hooks
-Project-URL: Source, https://github.com/ansys/pre-commit-hooks
-Project-URL: Tracker, https://github.com/ansys/pre-commit-hooks/issues
-Provides-Extra: doc
-Provides-Extra: tests
-
 Ansys pre-commit hooks
 ======================
 |pyansys| |python| |pypi| |GH-CI| |MIT| |black| |pre-commit-ci|
@@ -68,8 +36,8 @@ Currently, these hooks are available:
 * ``add-license-headers``: Add missing license headers to files by using
   `REUSE <https://reuse.software/>`_ . To use this hook, you must
   have ``REUSE`` implemented in your repository.
-
-|
+* ``tech-review``: Do a technical review of your repository according to
+  `Ansys repository requirements <https://dev.docs.pyansys.com/packaging/structure.html>`_`
 
 ``add-license-headers`` setup
 -----------------------------
@@ -116,7 +84,7 @@ Set custom arguments
 .. code:: yaml
 
    - repo: https://github.com/ansys/pre-commit-hooks
-   rev: v0.3.2
+   rev: v0.4.1
    hooks:
    - id: add-license-headers
      args: ["--custom_copyright", "custom copyright phrase", "--custom_template", "template_name", "--custom_license", "license_name", "--ignore_license_check", "--start_year", "2023"]
@@ -161,7 +129,7 @@ the hook should run on, add the necessary regex to the ``files`` line in your
 .. code:: yaml
 
    - repo: https://github.com/ansys/pre-commit-hooks
-     rev: v0.3.2
+     rev: v0.4.1
      hooks:
      - id: add-license-headers
        files: '(src|examples|tests|newFolder)/.*\.(py|newExtension)|\.(proto|newExtension)'
@@ -174,7 +142,7 @@ In .pre-commit-config.yaml:
 .. code:: yaml
 
   - repo: https://github.com/ansys/pre-commit-hooks
-    rev: v0.3.2
+    rev: v0.4.1
     hooks:
     - id: add-license-headers
       exclude: |
@@ -192,6 +160,59 @@ In .pre-commit-config.yaml:
 * ``.*\.js`` excludes all .js files in all directories.
 * ``\..*`` excludes all hidden files.
 
+``tech-review`` setup
+---------------------
+
+These are the default values for the arguments of the tech-review hook:
+
+* ``--author_maint_name=ANSYS, Inc.``
+* ``--author_maint_email=pyansys.core@ansys.com``
+* ``--license=MIT``
+* ``--url=https://github.com/ansys/{repo-name}``, replacing ``repo-name`` with the name of the repository
+
+The ``--author_maint_name`` is the name of the author and maintainer in the ``pyproject.toml`` file.
+By default, it is "Ansys, Inc.".
+
+The ``--author_maint_email`` is the email of the author and maintainer in the ``pyproject.toml`` file.
+By default, it is "pyansys.core@ansys.com".
+
+The ``--license`` argument is the license that is being used by your repository. By default, it is
+MIT.
+
+The ``--url`` argument is automatically rendered based on the repository name. If your repository
+is not in the Ansys organization, please add this argument to your configuration in
+.pre-commit-config.yaml.
+
+The ``--product`` argument is required if a ``README.rst`` or ``README.md`` file does not
+exist in your repository and you want the template to render correctly. The product
+for ``PyMechanical`` would be ``mechanical``, for example.
+
+The ``--non_compliant_name`` flag can be used if your repository does not follow the typical
+naming convention of ``ansys-*-*``.
+
+Technical review hook in ``ansys/pre-commit-hooks``' .pre-commit-config.yaml file:
+
+.. code:: yaml
+
+  - repo: https://github.com/ansys/pre-commit-hooks
+    rev: v0.4.1
+    hooks:
+    - id: tech-review
+      args:
+      - --product=pre_commit_hooks
+      - --non_compliant_name
+
+Technical review hook in ``PyMechanical``'s .pre-commit-config.yaml file:
+
+.. code:: yaml
+
+  - repo: https://github.com/ansys/pre-commit-hooks
+    rev: v0.4.1
+    hooks:
+    - id: tech-review
+      args:
+      - --product=mechanical
+
 
 How to install
 --------------
@@ -363,4 +384,3 @@ the building requirements and then execute the build module with these commands:
 .. _pytest: https://docs.pytest.org/en/stable/
 .. _Sphinx: https://www.sphinx-doc.org/en/master/
 .. _tox: https://tox.wiki/
-

ansys_pre_commit_hooks-0.4.1/pyproject.toml

@@ -0,0 +1,76 @@
+[build-system]
+requires = [
+    "setuptools>=42.0",
+    "GitPython==3.1.43",
+    "Jinja2==3.1.4",
+    "reuse==3.0.2",
+    "requests==2.32.3",
+    "semver==3.0.2",
+    "toml==0.10.2",
+    "wheel",
+]
+build-backend = "setuptools.build_meta"
+
+[tool.black]
+line-length = 100
+
+[tool.isort]
+profile = "black"
+force_sort_within_sections = true
+line_length = 100
+src_paths = ["doc", "src", "tests"]
+
+[tool.codespell]
+ignore-words = "doc/styles/config/vocabularies/ANSYS/accept.txt"
+
+[tool.coverage.run]
+source = ["ansys.pre_commit_hooks"]
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.pytest.ini_options]
+minversion = "7.1"
+addopts = "--cov=ansys.pre_commit_hooks --cov-report term-missing -vv"
+testpaths = [
+    "tests",
+]
+markers = [
+    "license_headers: marks tests for add-license-headers hook",
+    "tech_review: marks tests for tech-review hook",
+]
+
+[tool.towncrier]
+package = "ansys.pre_commit_hooks"
+directory = "doc/changelog.d"
+filename = "CHANGELOG.md"
+start_string = "<!-- towncrier release notes start -->\n"
+underlines = ["", "", ""]
+template = "doc/changelog.d/changelog_template.jinja"
+title_format = "## [{version}](https://github.com/ansys/pre-commit-hooks/releases/tag/v{version}) - {project_date}"
+issue_format = "[#{issue}](https://github.com/ansys/pre-commit-hooks/pull/{issue})"
+
+[[tool.towncrier.type]]
+directory = "added"
+name = "Added"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "changed"
+name = "Changed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "fixed"
+name = "Fixed"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "dependencies"
+name = "Dependencies"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "miscellaneous"
+name = "Miscellaneous"
+showcontent = true

ansys_pre_commit_hooks-0.4.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ansys_pre_commit_hooks-0.4.1/setup.py

@@ -0,0 +1,109 @@
+"""Installation file for ansys-pre-commit-hooks."""
+
+import os
+import sys
+
+from setuptools import find_namespace_packages, setup
+from setuptools.command.develop import develop
+from setuptools.command.install import install
+
+SCRIPT_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "src", "ansys")
+
+sys.path.append(os.path.dirname(SCRIPT_DIR))
+
+from ansys.pre_commit_hooks.tech_review import JSON_URL, LICENSES_JSON, download_license_json
+
+
+class CustomInstallCommand(install):
+    """Custom install command to download the license json file."""
+
+    def run(self):
+        """Download the license json file."""
+        install.run(self)
+        download_license_json(JSON_URL, LICENSES_JSON)
+
+
+class CustomDevelopCommand(develop):
+    """Custom develop command to download the license json file."""
+
+    def run(self):
+        """Download the license json file."""
+        develop.run(self)
+        download_license_json(JSON_URL, LICENSES_JSON)
+
+
+HERE = os.path.abspath(os.path.dirname(__file__))
+with open(os.path.join(HERE, "src", "ansys", "pre_commit_hooks", "VERSION"), encoding="utf-8") as f:
+    version = f.read().strip()
+
+# Get the long description from the README file
+with open(os.path.join(HERE, "README.rst"), encoding="utf-8") as f:
+    long_description = f.read()
+
+description = "A Python wrapper to create Ansys-tailored pre-commit hooks"
+
+setup(
+    name="ansys-pre-commit-hooks",
+    packages=find_namespace_packages(where="src", include="ansys*"),
+    package_dir={"": "src"},
+    version=version,
+    description=description,
+    long_description=long_description,
+    license="MIT",
+    author="ANSYS, Inc.",
+    author_email="pyansys.core@ansys.com",
+    maintainer="ANSYS, Inc.",
+    maintainer_email="pyansys.core@ansys.com",
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Intended Audience :: Science/Research",
+        "Topic :: Scientific/Engineering :: Information Analysis",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+    ],
+    url="https://github.com/ansys/pre-commit-hooks",
+    python_requires=">=3.9,<4",
+    install_requires=[
+        "GitPython==3.1.43",
+        "importlib-metadata==8.0.0",
+        "Jinja2==3.1.4",
+        "reuse==3.0.2",
+        "requests==2.32.3",
+        "semver==3.0.2",
+        "toml==0.10.2",
+    ],
+    extras_require={
+        "doc": [
+            "ansys-sphinx-theme[autoapi]==0.16.6",
+            "numpydoc==1.7.0",
+            "sphinx==7.4.0",
+            "sphinx-autodoc-typehints==2.2.2",
+            "sphinx-copybutton==0.5.1",
+        ],
+        "tests": [
+            "pytest==8.2.2",
+            "pytest-cov==5.0.0",
+        ],
+    },
+    project_urls={
+        "Source": "https://github.com/ansys/pre-commit-hooks/",
+        "Tracker": "https://github.com/ansys/pre-commit-hooks/issues",
+        "Homepage": "https://github.com/ansys/pre-commit-hooks",
+        "Documentation": "https://pre-commit-hooks.docs.pyansys.com",
+    },
+    include_package_data=True,
+    cmdclass={
+        "develop": CustomDevelopCommand,
+        "install": CustomInstallCommand,
+    },
+    entry_points={
+        "console_scripts": [
+            "add-license-headers=ansys.pre_commit_hooks.add_license_headers:main",
+            "tech-review=ansys.pre_commit_hooks.tech_review:main",
+        ],
+    },
+)

ansys_pre_commit_hooks-0.4.1/src/ansys/pre_commit_hooks/VERSION

@@ -0,0 +1 @@
+0.4.1

{ansys_pre_commit_hooks-0.3.2 → ansys_pre_commit_hooks-0.4.1}/src/ansys/pre_commit_hooks/__init__.py

@@ -22,9 +22,10 @@
 
 """Module for initializing package-level imports for Ansys pre-commit hooks."""
 
-try:
-    import importlib.metadata as importlib_metadata
-except ModuleNotFoundError:  # pragma: no cover
-    import importlib_metadata
+import pathlib
 
-__version__ = importlib_metadata.version(__name__.replace(".", "-").replace("_", "-"))
+__all__ = ["__version__"]
+
+
+with open(pathlib.Path(__file__).parent / "VERSION", encoding="utf-8") as f:
+    __version__ = f.read().strip()