Skip to content

Latest commit

 

History

History
50 lines (50 loc) · 1.1 KB

COOKIECUTTER-EXPLANATION.md

File metadata and controls

50 lines (50 loc) · 1.1 KB

Explanation of cookiecutter fields


project_name

Project name. Used in

  • README.md

project_slug

Project name in snake_case. Used in

  • Root dir folder name
  • Project folder name
  • README.md badges
  • pyproject.toml
  • Makefile
  • Tests example

project_description

Project long description (1-2 sentences)

  • README.md
  • pyproject.toml as package description

author_name

Author real name

  • LICENSE
  • pyproject.toml as package author

author_email

Author contact email

  • LICENSE
  • pyproject.toml as package author email

development_python_version

Python version used in developing

  • In workflows' jobs on publishing and coverage report
  • pyproject.toml as package author email
  • Makefile as package author email

min_supported_version

  • pyproject.toml

github_project_name

GitHub username + project name i.e. deknowny/python-package-template

  • README.md badges
  • pyproject.toml

github_branch_name

GitHub main branch name


docs_uri

Project site/documentation uri

  • README.md