summaryrefslogtreecommitdiff
path: root/wheel/test/pydist-schema.json
blob: 566f3a4d3f0cbc59f1b7a85631fac90c4df0a389 (plain)
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
{
  "id": "http://www.python.org/dev/peps/pep-0426/",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Metadata for Python Software Packages 2.0",
  "type": "object",
  "properties": {
    "metadata_version": {
      "description": "Version of the file format",
      "type": "string",
      "pattern": "^(\\d+(\\.\\d+)*)$"
    },
    "generator": {
      "description": "Name and version of the program that produced this file.",
      "type": "string",
      "pattern": "^[0-9A-Za-z]([0-9A-Za-z_.-]*[0-9A-Za-z])( \\(.*\\))?$"
    },
    "name": {
      "description": "The name of the distribution.",
      "type": "string",
      "$ref": "#/definitions/distribution_name"
    },
    "version": {
      "description": "The distribution's public version identifier",
      "type": "string",
      "pattern": "^(\\d+(\\.\\d+)*)((a|b|c|rc)(\\d+))?(\\.(post)(\\d+))?(\\.(dev)(\\d+))?$"
    },
    "source_label": {
      "description": "A constrained identifying text string",
      "type": "string",
      "pattern": "^[0-9a-z_.-+]+$"
    },
    "source_url": {
      "description": "A string containing a full URL where the source for this specific version of the distribution can be downloaded.",
      "type": "string",
      "format": "uri"
    },
    "summary": {
      "description": "A one-line summary of what the distribution does.",
      "type": "string"
    },
    "extras": {
      "description": "A list of optional sets of dependencies that may be used to define conditional dependencies in \"may_require\" and similar fields.",
      "type": "array",
      "items": {
        "type": "string",
        "$ref": "#/definitions/extra_name"
      }
    },
    "meta_requires": {
      "description": "A list of subdistributions made available through this metadistribution.",
      "type": "array",
      "$ref": "#/definitions/dependencies"
    },
    "run_requires": {
      "description": "A list of other distributions needed to run this distribution.",
      "type": "array",
      "$ref": "#/definitions/dependencies"
    },
    "test_requires": {
      "description": "A list of other distributions needed when this distribution is tested.",
      "type": "array",
      "$ref": "#/definitions/dependencies"
    },
    "build_requires": {
      "description": "A list of other distributions needed when this distribution is built.",
      "type": "array",
      "$ref": "#/definitions/dependencies"
    },
    "dev_requires": {
      "description": "A list of other distributions needed when this distribution is developed.",
      "type": "array",
      "$ref": "#/definitions/dependencies"
    },
    "provides": {
      "description": "A list of strings naming additional dependency requirements that are satisfied by installing this distribution. These strings must be of the form Name or Name (Version)",
      "type": "array",
      "items": {
        "type": "string",
        "$ref": "#/definitions/provides_declaration"
      }
    },
    "modules": {
      "description": "A list of modules and/or packages available for import after installing this distribution.",
      "type": "array",
      "items": {
        "type": "string",
        "$ref": "#/definitions/qualified_name"
      }
    },
    "namespaces": {
      "description": "A list of namespace packages this distribution contributes to",
      "type": "array",
      "items": {
        "type": "string",
        "$ref": "#/definitions/qualified_name"
      }
    },
    "obsoleted_by": {
      "description": "A string that indicates that this project is no longer being developed. The named project provides a substitute or replacement.",
      "type": "string",
      "$ref": "#/definitions/requirement"
    },
    "supports_environments": {
      "description": "A list of strings specifying the environments that the distribution explicitly supports.",
      "type": "array",
      "items": {
        "type": "string",
        "$ref": "#/definitions/environment_marker"
      }
    },
    "install_hooks": {
      "description": "The install_hooks field is used to define various operations that may be invoked on a distribution in a platform independent manner.",
      "type": "object",
      "properties": {
        "postinstall": {
          "type": "string",
          "$ref": "#/definitions/export_specifier"
        },
        "preuninstall": {
          "type": "string",
          "$ref": "#/definitions/export_specifier"
        }
      }
    },
    "extensions": {
      "description": "Extensions to the metadata may be present in a mapping under the 'extensions' key.",
      "type": "object",
      "$ref": "#/definitions/extensions"
    }
  },

  "required": ["metadata_version", "name", "version", "summary"],
  "additionalProperties": false,

  "definitions": {
    "contact": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "role": {
          "type": "string"
        }
      },
      "required": ["name"],
      "additionalProperties": false
    },
    "dependencies": {
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "#/definitions/dependency"
      }
    },
    "dependency": {
      "type": "object",
      "properties": {
        "extra": {
          "type": "string",
          "$ref": "#/definitions/extra_name"
        },
        "environment": {
          "type": "string",
          "$ref": "#/definitions/environment_marker"
        },
        "requires": {
          "type": "array",
          "items": {
            "type": "string",
            "$ref": "#/definitions/requirement"
          }
        }
      },
      "required": ["requires"],
      "additionalProperties": false
    },
    "extensions": {
      "type": "object",
      "patternProperties": {
        "^[A-Za-z][0-9A-Za-z_]*([.][0-9A-Za-z_]*)*$": {}
      },
      "properties": {
        "python.details" : {
          "description": "More information regarding the distribution.",
          "type": "object",
          "properties": {
            "document_names": {
              "description": "Names of supporting metadata documents",
              "type": "object",
              "properties": {
                "description": {
                  "type": "string",
                  "$ref": "#/definitions/document_name"
                },
                "changelog": {
                  "type": "string",
                  "$ref": "#/definitions/document_name"
                },
                "license": {
                  "type": "string",
                  "$ref": "#/definitions/document_name"
                }
              },
              "additionalProperties": false
            },
            "keywords": {
              "description": "A list of additional keywords to be used to assist searching for the distribution in a larger catalog.",
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "license": {
              "description": "A string indicating the license covering the distribution.",
              "type": "string"
            },
            "classifiers": {
              "description": "A list of strings, with each giving a single classification value for the distribution.",
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "python.project" : {
          "description": "More information regarding the creation and maintenance of the distribution.",
          "$ref": "#/definitions/project_or_integrator"
        },
        "python.integrator" : {
          "description": "More information regarding the downstream redistributor of the distribution.",
          "$ref": "#/definitions/project_or_integrator"
        },
        "python.commands" : {
          "description": "Command line interfaces provided by this distribution",
          "type": "object",
          "$ref": "#/definitions/commands"
        },
        "python.exports" : {
          "description": "Other exported interfaces provided by this distribution",
          "type": "object",
          "$ref": "#/definitions/exports"
        }
      },
      "additionalProperties": false
    },
    "commands": {
      "type": "object",
      "properties": {
        "wrap_console": {
          "type": "object",
          "$ref": "#/definitions/command_map"
        },
        "wrap_gui": {
          "type": "object",
          "$ref": "#/definitions/command_map"
        },
        "prebuilt": {
          "type": "array",
          "items": {
            "type": "string",
            "$ref": "#/definitions/relative_path"
          }
        }
      },
      "additionalProperties": false
    },
    "exports": {
      "type": "object",
      "patternProperties": {
        "^[A-Za-z][0-9A-Za-z_]*([.][0-9A-Za-z_]*)*$": {
          "type": "object",
          "patternProperties": {
            ".": {
              "type": "string",
              "$ref": "#/definitions/export_specifier"
            }
          },
          "additionalProperties": false
        }
      },
      "additionalProperties": false
    },
    "command_map": {
      "type": "object",
      "patternProperties": {
        "^[0-9A-Za-z]([0-9A-Za-z_.-]*[0-9A-Za-z])?$": {
          "type": "string",
          "$ref": "#/definitions/export_specifier"
        }
      },
      "additionalProperties": false
    },
    "project_or_integrator" : {
      "type": "object",
      "properties" : {
        "contacts": {
          "description": "A list of contributor entries giving the recommended contact points for getting more information about the project.",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/contact"
          }
        },
        "contributors": {
          "description": "A list of contributor entries for other contributors not already listed as current project points of contact.",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/contact"
          }
        },
        "project_urls": {
          "description": "A mapping of arbitrary text labels to additional URLs relevant to the project.",
          "type": "object"
        }
      }
    },
    "distribution_name": {
      "type": "string",
      "pattern": "^[0-9A-Za-z]([0-9A-Za-z_.-]*[0-9A-Za-z])?$"
    },
    "requirement": {
      "type": "string"
    },
    "provides_declaration": {
      "type": "string"
    },
    "environment_marker": {
      "type": "string"
    },
    "document_name": {
      "type": "string"
    },
    "extra_name" : {
      "type": "string",
      "pattern": "^[0-9A-Za-z]([0-9A-Za-z_.-]*[0-9A-Za-z])?$"
    },
    "relative_path" : {
      "type": "string"
    },
    "export_specifier": {
      "type": "string",
      "pattern": "^([A-Za-z_][A-Za-z_0-9]*([.][A-Za-z_][A-Za-z_0-9]*)*)(:[A-Za-z_][A-Za-z_0-9]*([.][A-Za-z_][A-Za-z_0-9]*)*)?(\\[[0-9A-Za-z]([0-9A-Za-z_.-]*[0-9A-Za-z])?\\])?$"
    },
    "qualified_name" : {
      "type": "string",
      "pattern": "^[A-Za-z_][A-Za-z_0-9]*([.][A-Za-z_][A-Za-z_0-9]*)*$"
    },
    "prefixed_name" : {
      "type": "string",
      "pattern": "^[A-Za-z_][A-Za-z_0-9]*([.][A-Za-z_0-9]*)*$"
    }
  }
}