RM001

class src.ansys.pre_commit_hooks.quality_rules.readme.RM001

Bases: README

README has a PyAnsys or Ansys badge.

Looks for a PyAnsys or Ansys badge image, such as an img.shields.io badge named Py-Ansys or Ansys, or any badge image URL that contains pyansys. The ansys organization name in a GitHub URL, for example in a workflow badge, does not count.

Notes

• A missing badge produces an error, including when there is no README file.

Overview

Static methods

check

Return whether the README contains a PyAnsys or Ansys badge.

Import detail

from src.ansys.pre_commit_hooks.quality_rules.readme import RM001

Method detail

static RM001.check(repository_root: pathlib.Path, readme_file: str | None) → ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult

Return whether the README contains a PyAnsys or Ansys badge.

Parameters:

repository_rootpathlib.Path

Repository root directory.

readme_filestr or None

Name of the detected README file, or None if there is none.

Returns:

bool or str

True if the badge is found, otherwise an "ERROR: ..." message.