Contributing

Guidance on contributing to a PyAnsys library appears in the Contributing topic in the PyAnsys Developer’s Guide. Ensure that you are thoroughly familiar with it before attempting to contribute to the PyAnsys Tools Report repository.

The following contribution information is specific to the PyAnsys Tools Report repository.

Cloning the PyAnsys Tools Report repository

Run this code to clone and install the latest version of the repository in development mode:

git clone https://github.com/ansys/pyansys-tools-report.git
cd pyansys-tools-report
pip install .

In case of looking for the test requirements, run the following:

pip install .[test]

Building documentation

To build the documentation locally you need to follow these steps at the root directory of the repository:

pip install .[doc]
make -C doc html

After the build completes the HTML documentation locates itself in the _builds/html directory and you can load the index.html into a web browser. To clean the documentation you can execute this command:

make -C doc clean

Posting issues

Use the PyAnsys Tools Report Issues page to submit questions, report bugs, and request new features.

Code style

PyAnsys Tools Report is compliant with PyAnsys Development Code Style Guide. Code style checks use pre-commit. Install this tool and activate it executing the following commands:

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

Then, you can make used of the available configuration file .pre-commit-config.yml, which will be automatically detected by pre-commit:

pre-commit run --all-files --show-diff-on-failure