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>_

How to install

The following sections provide instructions for installing the ansys-pre-commit-hooks package in two installation modes: user and developer.

For users ^^^^^^^^^

Before installing the package, to ensure that you have the latest version of pip_, run this command:

.. code:: bash

python -m pip install -U pip

Then, to install the package, run this command:

.. code:: bash

python -m pip install ansys-pre-commit-hooks

For developers ^^^^^^^^^^^^^^

Installing the package in developer mode allows you to modify and enhance the source code.

Before contributing to the project, ensure that you are familiar with the PyAnsys Developer's Guide_.

For a developer installation, you must follow these steps:

#. Clone the repository with this command:

.. code:: bash

  git clone https://github.com/ansys/pre-commit-hooks

#. Create a fresh-clean Python environment and activate it with these commands:

.. code:: bash

  # Create a virtual environment
  python -m venv .venv

  # Activate it in a POSIX system
  source .venv/bin/activate

  # Activate it in Windows CMD environment
  .venv\Scripts\activate.bat

  # Activate it in Windows Powershell
  .venv\Scripts\Activate.ps1

#. Ensure that you have the latest required build system tools by running this command:

.. code:: bash

  python -m pip install -U pip flit tox twine

#. Install the project in editable mode by running one of these commands:

.. code:: bash

  # Install the minimum requirements
  python -m pip install -e .

  # Install the minimum + tests requirements
  python -m pip install -e .[tests]

  # Install the minimum + doc requirements
  python -m pip install -e .[doc]

  # Install all requirements
  python -m pip install -e .[tests,doc]

#. Verify your development installation by running this command:

.. code:: bash

tox

How to test it

This project takes advantage of tox_. This tool automates common development tasks (similar to Makefile), but it is oriented towards Python development.

Using tox ^^^^^^^^^^^^^

While Makefile has rules, tox has environments. In fact, tox creates its own virtual environment so that anything being tested is isolated from the project to guarantee the project's integrity.

These environment commands are provided:

tox -e style: Checks for coding style quality.
tox -e py: Checks for unit tests.
tox -e py-coverage: Checks for unit testing and code coverage.
tox -e doc: Checks for successfully building the documentation.

Raw testing ^^^^^^^^^^^

If required, you can always call style commands, such as black, isort, and flake8, or unit testing commands, such as pytest, from the command line. However, calling these commands does not guarantee that your project is being tested in an isolated environment, which is the reason why tools like tox exist.

A note on pre-commit ^^^^^^^^^^^^^^^^^^^^^^^^

The style checks take advantage of pre-commit_. Developers are not forced but encouraged to install this tool by running this command:

.. code:: bash

python -m pip install pre-commit && pre-commit install

Documentation

For building documentation, you can run the usual rules provided in the Sphinx_ Makefile with a command that is formatted like this:

.. code:: bash

make -C doc/ html && your_browser_name doc/html/index.html

However, the recommended way of checking documentation integrity is by running tox with a command that is formatted like this:

.. code:: bash

tox -e doc && your_browser_name .tox/doc_out/index.html

Distributing

If you would like to create either source or wheel files, install the building requirements and then execute the build module with these commands:

.. code:: bash

python -m pip install .
python -m build
python -m twine check dist/*

.. LINKS AND REFERENCES .. _black: https://github.com/psf/black .. _flake8: https://flake8.pycqa.org/en/latest/ .. _isort: https://github.com/PyCQA/isort .. _pip: https://pypi.org/project/pip/ .. _pre-commit: https://pre-commit.com/ .. _PyAnsys Developer's Guide: https://dev.docs.pyansys.com/ .. _pytest: https://docs.pytest.org/en/stable/ .. _Sphinx: https://www.sphinx-doc.org/en/master/ .. _tox: https://tox.wiki/

FAQs

What is ansys-pre-commit-hooks?

Is ansys-pre-commit-hooks well maintained?

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install