pre_gen_project =============== .. py:module:: pre_gen_project .. autoapi-nested-parse:: This module contains hooks which are executed before the template is rendered. Attributes ---------- .. autoapisummary:: pre_gen_project.MODULE_REGEX pre_gen_project.PYTHONVERSION_REGEX pre_gen_project.PYTHONVERSION_MIN pre_gen_project.EXCEPTION_MSG_MODULE_NAME pre_gen_project.EXCEPTION_MSG_PYTHONVERSION pre_gen_project._ Functions --------- .. autoapisummary:: pre_gen_project.main Module Contents --------------- .. py:data:: MODULE_REGEX :value: '^[_a-zA-Z][_a-zA-Z0-9]*$' .. py:data:: PYTHONVERSION_REGEX :value: '^(3\\.(1[0-9]|[2-9][0-9])(\\.[0-9]{1,2})?)$' .. py:data:: PYTHONVERSION_MIN :value: '3.10' .. py:data:: EXCEPTION_MSG_MODULE_NAME :value: Multiline-String .. raw:: html
Show Value .. code-block:: python """ ERROR: The project slug ({module_name}) is not a valid Python module name. Please do not use anything other than letters, numbers, and underscores '_'. The first character must not be a number. """ .. raw:: html
.. py:data:: EXCEPTION_MSG_PYTHONVERSION :value: Multiline-String .. raw:: html
Show Value .. code-block:: python """ ERROR: The python version must be >= {min_python_version}, got {python_version}. """ .. raw:: html
.. py:data:: _ :value: Multiline-String .. raw:: html
Show Value .. code-block:: python """{{ cookiecutter.update( { "__package_name": cookiecutter.package_name|lower|replace(' ', '_')|replace('-', '_'), } )}}""" .. raw:: html
.. py:function:: main() -> None Apply pre-generation hooks.