The tech_review.py module

Summary

Enums

Filenames	Enum of files to check.
Directories	Enum of directories to check.

Functions

check_dirs_exist	Check folders exist in the root of the git repository.
check_config_file	Check naming convention, version, author, and maintainer information.
check_pyproject_toml	Check pyproject.toml file for correct naming convention, version, author, and maintainer.
check_auth_maint	Check if the author and maintainer names and emails are the same.
check_setup_py	Check setup.py file for correct naming convention, version, author, and maintainer.
download_license_json	Download the licenses.json file and restructure it to only include the license ID and name.
restructure_json	Remove extra information from licenses.json file.
check_file_exists	Check files exist. If they do not exist, create them using jinja templates.
generate_file_from_jinja	Generate file using jinja templates.
write_content	Write generated content from jinja template to a file.
check_file_content	Check the file content of the LICENSE and CONTRIBUTORS.md files.
main	Check files for technical review.

Constants

HOOK_PATH	Location of the pre-commit hook on your system.
LICENSES_JSON	JSON file containing licenses information.
DEFAULT_AUTHOR_MAINT_NAME	Default name of project authors and maintainers.
DEFAULT_AUTHOR_MAINT_EMAIL	Default email of project authors and maintainers.
DEFAULT_START_YEAR	Default start year of the repository.
DEFAULT_LICENSE	Default license of the repository
JSON_URL	URL to retrieve list of license IDs and names.

Description

Module for checking if a repository is compliant with required files in the technical review.

Module detail

tech_review.HOOK_PATH

Location of the pre-commit hook on your system.

tech_review.LICENSES_JSON

JSON file containing licenses information.

tech_review.DEFAULT_AUTHOR_MAINT_NAME = 'ANSYS, Inc.'

Default name of project authors and maintainers.

tech_review.DEFAULT_AUTHOR_MAINT_EMAIL = 'pyansys.core@ansys.com'

Default email of project authors and maintainers.

tech_review.DEFAULT_START_YEAR

Default start year of the repository.

tech_review.DEFAULT_LICENSE = 'MIT'

Default license of the repository

tech_review.JSON_URL = 'https://raw.githubusercontent.com/spdx/license-list-data/main/json/licenses.json'

URL to retrieve list of license IDs and names.