The readme.py module#

Summary#

README

README rule family.

RM000

README file exists.

RM001

README has a PyAnsys or Ansys badge.

RM002

README has a PyPI badge.

RM003

README has a license badge matching project metadata.

RM004

README has a GH-CI badge.

RM005

README has an installation section.

RM006

README has a documentation section.

RM007

README has a license section.

Description#

README quality checks.

This rule set validates that the repository README follows PyAnsys documentation standards and includes commonly expected project badges.

The checks cover:

  • README availability

    • README.rst (preferred)

    • README.md (supported but not preferred)

  • Badges

    • PyAnsys or Ansys badge

    • PyPI badge

    • Project license badge

    • GitHub Actions CI badge

  • Content sections

    • Installation

    • Documentation

    • License