-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathcopier.yml
More file actions
194 lines (167 loc) · 5.82 KB
/
copier.yml
File metadata and controls
194 lines (167 loc) · 5.82 KB
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
---
# =============================================================================
# Shared questions for all EasyScience templates
# =============================================================================
project_name:
type: str
default: EasyPeasy
help: |
What is the project name, including the `Easy` prefix?
Examples:
- EasyDiffraction
- EasyScience
project_shortcut:
type: str
default: EP
help: What is the project shortcut (2–3 letters)?
project_short_description:
type: str
default: Imaginary data analysis
help: |
What is the short description of the project (3–6 words)?
Examples:
- Diffraction data analysis
- Core building blocks for EasyScience
project_extended_description:
type: str
default: >-
A software for performing imaginary calculations based on a
imaginary model and refining its parameters against imaginary data
help: |
What is the extended description of the project, describing its purpose (1–3 sentences)?
Examples:
- A software for calculating neutron powder diffraction patterns based on a structural model and refining its parameters against experimental data
- The foundation of the framework, providing reusable building blocks for scientific libraries and applications aimed at making data analysis easier
project_copyright_years:
type: str
default: '2021-2026'
help: |
What is the project's copyright year(s)?
Examples:
- 2021-2026
- 2026
project_contact_email:
type: str
default: 'support@{{ project_name | lower }}.org'
help: What is the contact email address for the project?
---
# =============================================================================
# Project type selection (lib, app, both)
# =============================================================================
project_type:
type: str
choices:
- lib
- app
- both
default: both
help: |
What types will your project include?
- lib: Python library/package only
- app: Qt QML desktop application only
- both: Both Python library and Qt QML desktop application
template_type:
type: str
choices:
- home
- lib
- app
default: home
help: |
Which template do you want to apply right now?
- home: Creates shared metadata only
- lib: Python library/package
- app: Qt QML desktop application
---
# =============================================================================
# Home repository specific questions
# =============================================================================
home_repo_name:
when: '{{ project_type == "both" }}'
type: str
default: '{{ project_name | replace("Easy", "") | lower }}'
help: What is the project home repository under EasyScience organization?
home_page_url:
when: '{{ project_type == "both" }}'
type: str
default: 'https://easyscience.github.io/{{ home_repo_name }}'
help: What is the project's homepage URL?
---
# =============================================================================
# Library repository specific questions
# =============================================================================
lib_repo_name:
when: '{{ project_type in ["lib", "both"] }}'
type: str
default: '{{ home_repo_name }}-lib'
help:
What is the library repository for the project under the EasyScience organization?
lib_package_name:
when: '{{ project_type in ["lib", "both"] }}'
type: str
default: '{{ project_name | lower }}'
help: What is the name for the library Python package (use lowercase letters)?
lib_python_min:
when: '{{ project_type in ["lib", "both"] }}'
type: str
default: '3.11'
help: What is the minimum supported Python version for the library?
lib_python_max:
when: '{{ project_type in ["lib", "both"] }}'
type: str
default: '3.13'
help: What is the maximum supported Python version for the library?
lib_docs_url:
when: '{{ project_type in ["lib", "both"] }}'
type: str
default: 'https://easyscience.github.io/{{ lib_repo_name }}'
help: What is the documentation URL for the library?
lib_doi:
when: '{{ project_type in ["lib", "both"] }}'
type: str
default: '10.5281/zenodo.18163581'
help: |
What is the DOI for the library (without the URL prefix, e.g., 10.5281/zenodo.xxxxxxx)?
---
# =============================================================================
# Application repository specific questions
# =============================================================================
app_repo_name:
when: '{{ project_type in ["app", "both"] }}'
type: str
default: '{{ home_repo_name }}-app'
help:
What is the application repository for the project under the EasyScience
organization?
app_package_name:
when: '{{ project_type in ["app", "both"] }}'
type: str
default: '{{ project_name | lower }}_app'
help: |
What is the name for the application Python package (use lowercase letters)?
⚠️ Important: This should be different from the library package name, if the
project includes both.
app_python:
when: '{{ project_type in ["app", "both"] }}'
type: str
default: '3.13'
help: What is the Python version for the application?
app_docs_url:
when: '{{ project_type in ["app", "both"] }}'
type: str
default: 'https://easyscience.github.io/{{ app_repo_name }}'
help: What is the documentation URL for the application?
app_doi:
when: '{{ project_type in ["app", "both"] }}'
type: str
default: '10.5281/zenodo.18163581'
help: |
What is the DOI for the application (without the URL prefix, e.g., 10.5281/zenodo.xxxxxxx)?
---
# =============================================================================
# Template settings
# =============================================================================
_subdirectory: template
_answers_file: .copier-answers.yml
_exclude:
- '_exclude_*'