src.ansys.pre_commit_hooks.tech_review.check_pyproject_toml

src.ansys.pre_commit_hooks.tech_review.check_pyproject_toml(repo_path: str, author_maint_name: str, author_maint_email: str, is_compliant: bool, non_compliant_name: bool) → tuple

Check pyproject.toml file for correct naming convention, version, author, and maintainer.

Parameters:

repo_path: str

Path of the repository being checked.

author_maint_name: str

Project author and maintainer’s name.

author_maint_email: str

Project author and maintainer’s email.

is_compliant: bool

True if the repository is compliant. False if the repository is not compliant.

non_compliant_name: bool

True if the repository’s name is not in the form ansys-- and it is permitted. False if the repository’s name is in the form ansys--.

Returns:

bool

True if the pyproject.toml file’s information was correct. False if the pyproject.toml file had missing or incorrect information.

str

Name of the project from the pyproject.toml file.