Skip to content

Commit 15fde20

Browse files
Add copier.yml for template configuration
1 parent c808511 commit 15fde20

File tree

1 file changed

+128
-0
lines changed

1 file changed

+128
-0
lines changed

copier.yml

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# CONFIGURATION -------------------------
2+
_min_copier_version: "9"
3+
_envops:
4+
autoescape: false
5+
keep_trailing_newline: true
6+
_subdirectory: project
7+
_templates_suffix: .j2
8+
_preserve_symlinks: true
9+
_jinja_extensions:
10+
- copier_templates_extensions.TemplateExtensionLoader
11+
- extensions.py:CurrentYearExtension
12+
- extensions.py:GitExtension
13+
- extensions.py:SlugifyExtension
14+
_skip_if_exists:
15+
- CHANGELOG.md
16+
17+
# PROMPT --------------------------------
18+
project_name:
19+
type: str
20+
help: Your project name
21+
22+
project_description:
23+
type: str
24+
help: Your project description
25+
default: "Minimum Viable Python Template"
26+
27+
author_fullname:
28+
type: str
29+
help: Your full name
30+
default: "{{ 'Your Name' | git_user_name }}"
31+
32+
author_email:
33+
type: str
34+
help: Your email
35+
default: "{{ '[email protected]' | git_user_email }}"
36+
37+
author_username:
38+
type: str
39+
help: Your username (e.g. on GitHub)
40+
default: "pythoninthegrass"
41+
42+
repository_provider:
43+
type: str
44+
help: Your repository provider
45+
default: github.com
46+
choices:
47+
- github.com
48+
- gitlab.com
49+
- bitbucket.org
50+
51+
repository_namespace:
52+
type: str
53+
help: Your repository namespace
54+
default: "{{ author_username }}"
55+
56+
repository_name:
57+
type: str
58+
help: Your repository name
59+
default: "{{ project_name | slugify }}"
60+
61+
copyright_holder:
62+
type: str
63+
help: The name of the person/entity holding the copyright
64+
default: "{{ author_fullname }}"
65+
66+
copyright_holder_email:
67+
type: str
68+
help: The email of the person/entity holding the copyright
69+
default: "{{ author_email }}"
70+
71+
copyright_date:
72+
type: str
73+
help: The copyright date
74+
default: "{{ current_year }}"
75+
76+
copyright_license:
77+
type: str
78+
help: Your project's license
79+
default: Unlicense
80+
choices:
81+
Academic Free License v3.0: AFL-3.0
82+
Apache License 2.0: Apache-2.0
83+
Artistic License 2.0: Artistic-2.0
84+
BSD 2-Clause "Simplified" License: BSD-2-Clause
85+
BSD 3-Clause Clear License: BSD-3-Clause-Clear
86+
BSD 3-Clause "New" or "Revised" License: BSD-3-Clause
87+
Boost Software License 1.0: BSL-1.0
88+
Creative Commons Attribution 4.0 International: CC-BY-4.0
89+
Creative Commons Attribution Share Alike 4.0 International: CC-BY-SA-4.0
90+
Creative Commons Zero v1.0 Universal: CC0-1.0
91+
Do What The F*ck You Want To Public License: WTFPL
92+
Educational Community License v2.0: ECL-2.0
93+
Eclipse Public License 1.0: EPL-1.0
94+
Eclipse Public License 2.0: EPL-2.0
95+
European Union Public License 1.1: EUPL-1.1
96+
European Union Public License 1.2: EUPL-1.2
97+
GNU Affero General Public License v3.0: AGPL-3.0
98+
GNU General Public License v2.0 only: GPL-2.0
99+
GNU General Public License v3.0 only: GPL-3.0
100+
GNU Lesser General Public License v2.1 only: LGPL-2.1
101+
GNU Lesser General Public License v3.0 only: LGPL-3.0
102+
ISC License: ISC
103+
LaTeX Project Public License v1.3c: LPPL-1.3c
104+
MIT License: MIT
105+
Mozilla Public License 2.0: MPL-2.0
106+
Microsoft Public License: MS-PL
107+
Microsoft Reciprocal License: MS-RL
108+
University of Illinois/NCSA Open Source License: NCSA
109+
SIL Open Font License 1.1: OFL-1.1
110+
Open Software License 3.0: OSL-3.0
111+
PostgreSQL License: PostgreSQL
112+
The Unlicense: Unlicense
113+
zlib License: Zlib
114+
115+
python_package_distribution_name:
116+
type: str
117+
help: Your Python package distribution name (for `pip install NAME`)
118+
default: "{{ project_name | slugify }}"
119+
120+
python_package_import_name:
121+
type: str
122+
help: Your Python package import name (for `import NAME` in Python code)
123+
default: "{{ project_name | slugify('_') }}"
124+
125+
python_package_command_line_name:
126+
type: str
127+
help: Your CLI name if any (for use in the shell)
128+
default: "{{ project_name | slugify }}"

0 commit comments

Comments
 (0)