-
-
Notifications
You must be signed in to change notification settings - Fork 10
/
copier.yaml
198 lines (196 loc) · 7.1 KB
/
copier.yaml
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
_envops:
block_end_string: "%]"
block_start_string: "[%"
lstrip_blocks: true
trim_blocks: true
_subdirectory: template
_message_before_copy: |
Thanks for generating a project using our template.
You'll be asked a series of questions whose answers will be used to
generate a tailored project for you.
_message_after_copy: |
Your project "{{ project_name }}" has been created successfully!
_message_before_update: |
Thanks for updating your project using our template.
You'll be asked a series of questions whose answers are pre-populated
with previously entered values. Feel free to change them as needed.
_message_after_update: |
Your project "{{ project_name }}" has been updated successfully!
In case there are any conflicts, please resolve them. Then,
you're done.
project_name:
default: My Project
help: "Enter the name of the project in CamelCase format:"
type: str
project_description:
default: Project brief description.
help: "Provide a concise description to be used in the Python package overview and the introductory paragraph in the README and documentation's index page:"
type: str
development_status:
default: Alpha
choices:
- Alpha
- Beta
- Production/Stable
help: "Choose the development status:"
type: str
copyright_license:
default: MIT License
choices:
- Apache Software License
- Boost Software License 1.0 (BSL-1.0)
- GNU Affero General Public License v3
- GNU General Public License v3 (GPLv3)
- GNU Lesser General Public License v3 (LGPLv3)
- MIT License
- Mozilla Public License 2.0 (MPL 2.0)
- The Unlicense (Unlicense)
help: Choose the project's license (e.g. "MIT", "GPL-3.0").
type: str
copyright_year:
default: 2022-{{ "%Y" | strftime }}
help: Enter the copyright year or range (e.g. "2022-2023").
type: str
author_name:
default: Your Name
help: "Specify the name of the author:"
type: str
organization_name:
default: Your Organization Name
help: "Provide the name of the organization associated with the project:"
type: str
copyright_holder:
default: "{{ organization_name }}"
help: Name(s) or organization(s) holding the copyright.
type: str
author_email:
default: '{{ author_name|lower|replace(" ", ".") }}@{{ organization_name|lower|replace(" ", "-") }}.com'
help: "Specify the email address of the author:"
type: str
repo_platform:
default: github
choices:
GitHub: github
GitLab: gitlab
GitLab (self-managed): gitlab-self-managed
help: "Choose the platform for the repository:"
type: str
repo_host:
default: |-
[% if repo_platform == 'github' %]
github.com
[%- elif repo_platform == 'gitlab' %]
gitlab.com
[%- endif %]
help: "Specify the host of the self-managed GitLab:"
type: str
when: '{{ repo_platform == "gitlab-self-managed" }}'
page_host:
default: |-
[% if repo_platform == 'github' %]
github.io
[%- elif repo_platform == 'gitlab' %]
gitlab.io
[%- endif %]
help: "Specify the host of the self-managed GitLab Pages:"
type: str
when: '{{ repo_platform == "gitlab-self-managed" }}'
container_registry_host:
default: |-
[% if repo_platform == 'github' %]
ghcr.io
[%- elif repo_platform == 'gitlab' %]
registry.gitlab.com
[%- endif %]
help: "Specify the host of the self-managed GitLab Container Registry:"
type: str
when: '{{ repo_platform == "gitlab-self-managed" }}'
repo_namespace:
default: '{{ organization_name|lower|replace(" ", "-") }}'
help: "Indicate the GitHub Repository Owner or GitLab Namespace. This is typically the account name of the author or the organization:"
type: str
repo_name:
default: '{{ project_name|lower|replace(" ", "-") }}'
help: "Provide a name for the repository:"
type: str
package_name:
default: '{{ repo_name|regex_replace("-python$", "") }}'
help: 'Specify the name of the distributable package for the project (often used in "pip install <package_name>"):'
type: str
module_name:
default: '{{ package_name|lower|replace("-", "_") }}'
help: 'Specify the name of the primary module within the package (often used in "import <module_name>"):'
type: str
coverage_threshold:
default: 100
help: "Set the threshold for test coverage, ranging from 0 to 100:"
type: int
validator: "[% if not 0 <= coverage_threshold <= 100 %]Test Coverage threshold should be between 0 and 100[% endif %]"
platforms:
default: ["macos", "ubuntu", "windows"]
choices:
- macos
- ubuntu
- windows
help: "Set the supported platforms for the project:"
multiselect: true
type: str
min_py:
default: "3.12"
choices:
- "3.9"
- "3.10"
- "3.11"
- "3.12"
- "3.13"
help: "Choose the minimal Python version the project should support:"
type: str
max_py:
default: "3.12"
choices:
"3.9":
validator: '[% from pathjoin("includes", "version_compare.jinja") import version_higher_than_validator %]{{ version_higher_than_validator("3.9", min_py) }}'
value: "3.9"
"3.10":
validator: '[% from pathjoin("includes", "version_compare.jinja") import version_higher_than_validator %]{{ version_higher_than_validator("3.10", min_py) }}'
value: "3.10"
"3.11":
validator: '[% from pathjoin("includes", "version_compare.jinja") import version_higher_than_validator %]{{ version_higher_than_validator("3.11", min_py) }}'
value: "3.11"
"3.12":
validator: '[% from pathjoin("includes", "version_compare.jinja") import version_higher_than_validator %]{{ version_higher_than_validator("3.12", min_py) }}'
value: "3.12"
"3.13":
value: "3.13"
help: "Choose the maximal Python version the project should support:"
type: str
default_py:
default: "{{ max_py }}"
choices:
"3.9":
validator: '[% from pathjoin("includes", "version_compare.jinja") import version_between_validator %]{{ version_between_validator("3.9", min_py, max_py) }}'
value: "3.9"
"3.10":
validator: '[% from pathjoin("includes", "version_compare.jinja") import version_between_validator %]{{ version_between_validator("3.10", min_py, max_py) }}'
value: "3.10"
"3.11":
validator: '[% from pathjoin("includes", "version_compare.jinja") import version_between_validator %]{{ version_between_validator("3.11", min_py, max_py) }}'
value: "3.11"
"3.12":
validator: '[% from pathjoin("includes", "version_compare.jinja") import version_between_validator %]{{ version_between_validator("3.12", min_py, max_py) }}'
value: "3.12"
"3.13":
validator: '[% from pathjoin("includes", "version_compare.jinja") import version_between_validator %]{{ version_between_validator("3.13", min_py, max_py) }}'
value: "3.13"
help: "Choose the default Python version for development, documentation generation, and package build:"
type: str
readme_content:
default: |-
[% if project_name == 'Serious Scaffold Python' %]
[% from pathjoin("includes", "sample.jinja") import readme_content with context %]{{ readme_content() }}
[%- else %]
## A multiline README content here
[%- endif %]
help: "Provide a multiline content to be used in the README and documentation's index page:"
multiline: true
type: str