cookiecutter.json

{
  "project_name": "Python Project",
  "repo_name": "{{ cookiecutter.project_name.lower().split() | join('-') }}",
  "package_name": "{{ cookiecutter.repo_name.replace('-', '_') }}",
  "project_description": "{{ cookiecutter.project_name }} is a Python library created with https://gitlab.com/galactipy/galactipy",
  "copyright": "The Galactipy Contributors",
  "maintainer": "Manoel Pereira de Queiroz",
  "scm_platform": [
    "GitLab Free",
    "GitLab Premium/Ultimate",
    "GitHub"
  ],
  "scm_namespace": "galactipy",
  "email": "contact@{{ cookiecutter.scm_namespace.lower().split() | join('-') }}.com",
  "licence": [
    "MIT",
    "BSD-3-Clause",
    "GPL-3.0-or-later",
    "AGPL-3.0-or-later",
    "LGPL-3.0-or-later",
    "MPL-2.0",
    "Apache-2.0",
    "nos"
  ],
  "minimal_python_version": [
    "3.10",
    "3.11",
    "3.12",
    "3.13",
    "3.14"
  ],
  "line_length": 88,
  "docstring_style": [
    "numpy",
    "google",
    "sphinx",
    "other"
  ],
  "docstring_length": "{{ cookiecutter.line_length }}",
  "commit_convention": [
    "gitmoji",
    "conventional",
    "conventional-gitmoji"
  ],
  "use_bdd": true,
  "coverage_service": [
    "Codacy",
    "Coveralls"
  ],
  "create_docker": true,
  "app_type": [
    "tui",
    "hybrid",
    "cli",
    "bare_repo"
  ],

  "__prompts__": {
    "project_name": "Project name",
    "repo_name": "Project slug",
    "package_name": "Package name",
    "project_description": "Short description of the project",
    "copyright": "Copyright holder",
    "maintainer": "Project maintainer",
    "scm_platform": "In which platform would you like to host your code?",
    "scm_namespace": "Platform namespace",
    "email": "Contact email",
    "licence": {
      "__prompt__": "Which licence will you use for your project?",
      "MIT": "MIT Licence",
      "BSD-3-Clause": "3-Clause BSD",
      "GPL-3.0-or-later": "GNU GPL v3.0",
      "AGPL-3.0-or-later": "GNU AGPL v3.0",
      "LGPL-3.0-or-later": "GNU LGPL v3.0",
      "MPL-2.0": "Mozilla Public License 2.0",
      "Apache-2.0": "Apache Software License 2.0",
      "nos": "Non-OSS licence"
    },
    "minimal_python_version": "Minimal Python version",
    "line_length": "Maximum line length",
    "docstring_style": {
      "__prompt__": "Which docstring style would you like to use?",
      "numpy": "Numpydoc",
      "google": "Google Python Style",
      "sphinx": "Sphinx (reST Docstrings)",
      "other": "Other"
    },
    "docstring_length": "Docstring maximum line length",
    "use_bdd": "Use behaviour-driven development for testing?",
    "commit_convention": {
      "__prompt__": "Which commit convention would you like to use?",
      "gitmoji": "Gitmoji",
      "conventional": "Conventional Commits",
      "conventional-gitmoji": "Conventional Commits with Gitmoji"
    },
    "coverage_service": {
      "__prompt__": "What would you like to use for code quality services?",
      "Codacy": "Full code analysis with Codacy",
      "Coveralls": "Basic code coverage with Coveralls"
    },
    "create_docker": "Containerize your application with Docker?",
    "app_type": {
      "__prompt__": "Which kind of application do you want to build?",
      "tui": "Integrated CLI+TUI",
      "hybrid": "Hybrid CLI/TUI",
      "cli": "CLI-only application",
      "bare_repo": "Bare repository"
    }
  },

  "_licence_mapping_simple": {
    "MIT": ["the ", "MIT License"],
    "BSD-3-Clause": ["", "3-Clause BSD"],
    "GPL-3.0-or-later": ["", "GNU GPL 3.0"],
    "AGPL-3.0-or-later": ["", "GNU AGPL 3.0"],
    "LGPL-3.0-or-later": ["", "GNU LGPL 3.0"],
    "MPL-2.0": ["the ", "Mozilla Public License"],
    "Apache-2.0": ["the ", "Apache Software License"],
    "nos": "Non-OSS"
  },
  "_licence_mapping_extended": {
    "MIT": "MIT License",
    "BSD-3-Clause": "BSD 3-Clause License",
    "GPL-3.0-or-later": "GNU General Public License v3.0 or later",
    "AGPL-3.0-or-later": "GNU Affero General Public License v3.0 or later",
    "LGPL-3.0-or-later": "GNU Lesser General Public License v3.0 or later",
    "MPL-2.0": "Mozilla Public License 2.0",
    "Apache-2.0": "Apache Software License 2.0",
    "nos": "Non-OSS"
  },
  "__licence_extended": "{{ cookiecutter._licence_mapping_extended[cookiecutter.licence] }}",

  "_python_version_list_mapping": {
    "3.10": [3, 10],
    "3.11": [3, 11],
    "3.12": [3, 12],
    "3.13": [3, 13],
    "3.14": [3, 14]
  },
  "_python_version_support_mapping": {
    "3.10": [[3, 10], [3, 11], [3, 12], [3, 13], [3, 14]],
    "3.11": [[3, 11], [3, 12], [3, 13], [3, 14]],
    "3.12": [[3, 12], [3, 13], [3, 14]],
    "3.13": [[3, 13], [3, 14]],
    "3.14": [[3, 14]]
  },
  "__mpvr": "{{ cookiecutter.minimal_python_version.replace('.', '') }}",

  "__envvar": "{{ cookiecutter.package_name.upper() }}",
  "__security_email": "{{ cookiecutter.email.replace('.', ' dot ').replace('@', ' at ').replace('_', ' underscore ').replace('-', ' dash ') }}",

  "__scm_platform_base": "{{ 'GitLab' if 'GitLab' in cookiecutter.scm_platform else 'GitHub' }}",
  "__scm_platform_lc": "{{ cookiecutter.__scm_platform_base.lower() }}",
  "__scm_platform_redux": "{{ 'gl' if cookiecutter.__scm_platform_lc == 'gitlab' else 'gh' }}",
  "__scm_base_url": "https://{{ cookiecutter.__scm_platform_lc }}.com/{{ cookiecutter.scm_namespace }}/{{ cookiecutter.repo_name }}",
  "__scm_link_url": "https://{{ cookiecutter.__scm_platform_lc }}.com/{{ cookiecutter.scm_namespace }}/{{ cookiecutter.repo_name }}{% if cookiecutter.__scm_platform_lc == 'gitlab' %}/-{% endif %}",
  "__gitlab_org": "https://gitlab.com/groups/{{ cookiecutter.scm_namespace }}/-",
  "__gitlab_premium_templates": "https://gitlab.com/{{ cookiecutter.scm_namespace }}/templates/-/blob/master",
  "__contributing_prefix": "{{ cookiecutter.__gitlab_premium_templates ~ '/CONTRIBUTING.md' if cookiecutter.scm_platform == 'GitLab Premium/Ultimate' }}",

  "__mr_term": "{{ 'Merge Request' if cookiecutter.__scm_platform_redux == 'gl' else 'Pull Request' }}",
  "__mr_acronym": "{{ 'MR' if cookiecutter.__scm_platform_redux == 'gl' else 'PR' }}",
  "__mr_term_slug": "{{ 'merge-request' if cookiecutter.__scm_platform_redux == 'gl' else 'pull-request' }}",

  "__coverage_lc": "{{ cookiecutter.coverage_service.lower() }}",

  "__debug": false,
  "_copy_without_render": [
    "poetry.lock"
  ]
}