-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpython_schema.yaml
More file actions
167 lines (166 loc) · 6.2 KB
/
python_schema.yaml
File metadata and controls
167 lines (166 loc) · 6.2 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
# -*- mode: yaml; coding: utf-8 -*-
#
# Schema for the python plugin for spin
python:
properties:
pyenv:
type: object
help: |
Configuration related to pyenv is used for provisioning the
Python interpreter
properties:
url:
type: str
help: URL to install pyenv from
path:
type: path
help: Path to cache the pyenv sources
cache:
type: path
help: Path to cache the Python sources downloaded by pyenv
python_build:
type: path
help: Path to the python-build builtin plugin of pyenv
user_pyenv:
type: bool
help: |
If ``False`` install pyenv from sources, otherwise use the pyenv
from PATH
nuget:
type: object
help: |
Configuration related to the Python provision on Windows using
nuget
properties:
url:
type: str
help: URL to install nuget from
exe:
type: path
help: Path to nuget executable
source:
type: str
help: Index to use for nuget sources
version:
type: str
help: |
The Python version to use for the whole project when using in
the context of spin
use:
type: str
help: |
The use property can be used to specify an alternative Python
source to use. This is useful to rather use the system Python
than the one defined in spinfile.yaml
default: ''
inst_dir:
type: path
help: Path to the installation directory of Python.
interpreter:
type: path
help: The path to the Python interpreter of the instance to use.
venv:
type: path
help: |
Path to the virtual environment which is used exclusively for
the project spin is running on
memo:
type: path
help: Path to the memoizer used to list installed packages
bindir:
type: path
help: |
Path of the virtual environment's binary directory on Linux;
equals "{python.venv}" on Windows
scriptdir:
type: path
help: |
Directory containing the executables of the Python virtual
environment
python:
type: path
help: |
The python property defines the path to the Python interpreter
to use.
pipconf:
type: str
help: |
Content of the pip.conf/pip.ini configuration file that will be
written into the environment.
# The provisioner type is evaluated during runtime and to complex to
# represent it in the schema.
# provisioner:
# type:
# help:
site_packages:
type: path internal
help: The path to the virtual environments site-packages directory.
requirements:
type: list
help: |
The list of this project's external Python requirements, that
have to be installed into the project's virtual environment.
This excludes requirements stated as 'install_requires' in
setup.py/setup.cfg.
Note that editable installs with ``-e`` or requirement files
with ``-r`` can also be used here.
constraints:
type: list
help: |
The list of constraint files that should be used when
installing packages into the virtual environment.
index_url:
type: str
help: |
The index url from where packages should get installed into the
venv. This value will also be put into cfg.python.pipconf, if
not already mentioned there.
build_wheels:
type: list
help: |
A list of packages that will be built along with the current
project when executing python:wheel.
aws_auth:
type: object
help: Configuration for the 'aws_auth' extra.
properties:
enabled:
type: bool
help: |
Whether to enable AWS authentication for retrieving
packages from CodeArtifact.
memo:
type: path
help: |
Path to the memoized information regarding the aws_auth
extra.
key_duration:
type: int
help: |
Time in seconds defining how long the plugin should
consider the authentication token as valid before
issuing a new one.
static_oidc:
type: bool
help: |
Whether to static OIDC when authenticating with AWS
CodeArtifact.
index:
type: str
help: The CodeArtifact repository index (e.g. "16.0/simple").
client_id:
type: str
help: The OIDC client ID to use.
client_secret:
type: secret
help: |
The OIDC client secret to use, defaults to the
environment variable 'CS_AWS_OIDC_CLIENT_SECRET'.
role_arn:
type: str
help: The role ARN to assume when authenticating.
skip_js_build:
type: bool
help: |
If true the build_js part of setuptools_ce will be skipped
during provision.