python-project/cookiecutter.json at master · saezlab/python-project · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
{
    "project_name": "Project Name",
    "project_slug": "{{ cookiecutter.project_name|lower|replace(' ', '-') }}",
    "package_name": "{{ cookiecutter.project_slug|lower|replace('-', '_') }}",
    "project_profile": [
        "package",
        "workflow",
        "tiny"
    ],
    "short_description": "A great new project.",
    "readme": "{{ cookiecutter.short_description }}",
    "author_full_name": "Your Name",
    "author_email": "your@email",
    "github_organization": "saezlab",
    "project_repo": "https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_slug }}",
    "license": [
        "MIT License",
        "BSD 2-Clause License",
        "BSD 3-Clause License",
        "Apache License Version 2.0",
        "GNU General Public License Version 3",
        "GNU Lesser General Public License Version 3",
        "ISC License",
        "Unlicense"
    ],
    "_license": {
        "MIT License": {
            "license_short": "MIT",
            "license_classifiers": "MIT License",
            "license_spdx": "MIT"
        },
        "BSD 2-Clause License": {
            "license_short": "BSD-2-Clause",
            "license_classifiers": "BSD License",
            "license_spdx": "BSD-2-Clause"
        },
        "BSD 3-Clause License": {
            "license_short": "BSD-3-Clause",
            "license_classifiers": "BSD License",
            "license_spdx": "BSD-3-Clause"
        },
        "Apache License Version 2.0": {
            "license_short": "Apache-2.0",
            "license_classifiers": "Apache Software License",
            "license_spdx": "Apache-2.0"
        },
        "GNU General Public License Version 3": {
            "license_short": "GPL-3.0-or-later",
            "license_classifiers": "GNU General Public License v3 (GPLv3)",
            "license_spdx": "GPL-3.0-or-later"
        },
        "GNU Lesser General Public License Version 3": {
            "license_short": "LGPL-3.0-or-later",
            "license_classifiers": "GNU Lesser General Public License v3 (LGPLv3)",
            "license_spdx": "LGPL-3.0-or-later"
        },
        "ISC License": {
            "license_short": "ISC",
            "license_classifiers": "ISC License (ISCL)",
            "license_spdx": "ISC"
        },
        "Unlicense": {
            "license_short": "Unlicense",
            "license_classifiers": "The Unlicense (Unlicense)",
            "license_spdx": "Unlicense"
        }
    },
    "python_version": [
        "3.13",
        "3.12",
        "3.11",
        "3.10"
    ],
    "_python_versions": [
        "3.10",
        "3.11",
        "3.12",
        "3.13"
    ],
    "copyright_holder": "Heidelberg University Hospital",
    "include_security_workflow": [
        "no",
        "yes"
    ],
    "include_multiversion_testing": [
        "no",
        "yes"
    ],
    "__year": "{% now 'utc', '%Y' %}",
    "_extensions": [
        "cookiecutter.extensions.TimeExtension"
    ],
    "__prompts__": {
        "project_name": "Human readable name of the project, e.g. `My Great Project`",
        "project_slug": "Repository and PyPI name (derived from the project name)",
        "package_name": "Importable Python package name (derived from the slug)",
        "project_profile": {
            "__prompt__": "What kind of project is this?",
            "package": "package - a distributed library: full mkdocs site, full CI matrix, API reference, bump2version",
            "workflow": "workflow - an analysis or pipeline repo: lighter CI, README + quickstart only, no docs site",
            "tiny": "tiny - a scratch or single-purpose repo: pyproject.toml, ruff and pre-commit only"
        },
        "short_description": "One sentence describing the project",
        "readme": "Introductory paragraph for `README.md`",
        "author_full_name": "Full name of the main author",
        "author_email": "Contact email of the main author",
        "github_organization": "GitHub organization or user owning the repository",
        "project_repo": "URL of the GitHub repository",
        "license": "License to distribute the project under",
        "python_version": "Minimum supported Python version",
        "copyright_holder": "Legal entity holding the copyright",
        "include_security_workflow": {
            "__prompt__": "Add a `bandit` security scanning workflow?",
            "no": "no",
            "yes": "yes"
        },
        "include_multiversion_testing": {
            "__prompt__": "Add the `scripts/test-multi-py.py` local multi-version test helper?",
            "no": "no",
            "yes": "yes"
        }
    }
}