copier-python/copier.yaml at main · liblaf/copier-python · 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
# ref: <https://copier.readthedocs.io/en/stable/configuring/>
# ref: <https://gitlab.com/dreamer-labs/libraries/jinja2-ansible-filters/>
# ref: <https://jinja.palletsprojects.com/en/stable/templates/>

_answers_file: .config/copier/.copier-answers.python.yaml

_external_data:
  shared: "{{ answers_file_shared }}"

_envops:
  comment_start_string: "# {#"

_skip_if_exists:
  - .gitignore
  - .vscode/settings.json
  - docs/
  - noxfile.py
  - pyproject.toml
  - README.md
  - src/
  - zensical.toml

_subdirectory: template

_tasks:
  - rm --force --recursive '.config/copier/mise-tasks'
  - rm --force '.config/copier/mkdocs.yaml'
  - rm --force '.config/linters/pyrightconfig.json'
  - rm --force '.config/mise/conf.d/10-python.toml'
  - rm --force '.github/workflows/bench.yaml'
  - rm --force '.github/workflows/docs.yaml'
  - rm --force '.github/workflows/release.yaml'
  - rm --force '.github/workflows/test.yaml'

answers_file_shared:
  type: str
  help: Path to the shared Copier answers file used to preload project metadata.
  default: .config/copier/.copier-answers.shared.yaml

project_name:
  type: str
  default: "{{ _external_data.shared.project_name }}"
  when: false

project_name_slug:
  type: str
  default: "{{ _external_data.shared.project_name_slug }}"
  when: false

author_name:
  type: str
  default: "{{ _external_data.shared.author_name }}"
  when: false

author_email:
  type: str
  default: "{{ _external_data.shared.author_email }}"
  when: false

license:
  type: str
  default: "{{ _external_data.shared.license }}"
  when: false

github_user:
  type: str
  default: "{{ _external_data.shared.github_user }}"
  when: false

github_repo:
  type: str
  default: "{{ _external_data.shared.github_repo }}"
  when: false

namespace:
  type: str
  help: Python package namespace to prepend to the project package. Leave empty for a top-level package.
  default: "{{ github_user }}"

distribution_name:
  type: str
  help: Distribution name used for publishing and installation, such as the PyPI project name.
  default: |-
    {%- if namespace -%}
      {{ namespace | replace('.', '-') | replace('/', '-') }}-{{ project_name_slug }}
    {%- else -%}
      {{ project_name_slug }}
    {%- endif -%}

package_name:
  type: str
  help: Importable Python package name. Use dots to separate namespace packages.
  default: |-
    {%- if namespace -%}
      {{ namespace | replace('-', '_') }}.{{ project_name_slug | replace('-', '_') }}
    {%- else -%}
      {{ project_name_slug | replace('-', '_') }}
    {%- endif -%}

package_dir:
  type: str
  help: Directory under src/ that contains the package code.
  default: |-
    {{ package_name | replace('.', '/') }}

wheel_package_dir:
  type: str
  help: Top-level directory under src/ to include in the built wheel.
  default: |-
    {{ package_dir.split('/') | first }}