-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
pyproject.json
898 lines (898 loc) · 44.7 KB
/
pyproject.json
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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://json.schemastore.org/pyproject.json",
"$comment": "there are multiple resources describing pyproject.toml. The canonical reference is at https://packaging.python.org/en/latest/specifications/declaring-project-metadata/, which refers to multiple proposals such as PEP 517, PEP 518 and PEP 621",
"additionalProperties": false,
"definitions": {
"projectAuthor": {
"type": "object",
"additionalProperties": false,
"anyOf": [
{
"required": ["name"],
"properties": {
"name": true
}
},
{
"required": ["email"],
"properties": {
"email": true
}
}
],
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string",
"format": "email"
}
}
},
"BuildSystem": {
"type": "object",
"additionalProperties": false,
"required": ["requires"],
"title": "Project build system configuration",
"description": "Declares any Python level dependencies that must be installed in order to run the project’s build system successfully.",
"markdownDescription": "Declares any Python level dependencies that must be installed in order to run the project’s build system successfully.",
"x-intellij-html-description": "<p>Declares any Python level dependencies that must be installed in order to run the project’s build system successfully.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#declaring-build-system-dependencies-the-build-system-table"
}
},
"properties": {
"requires": {
"type": "array",
"items": {
"type": "string"
},
"title": "Build system dependencies",
"description": "List of strings following the version specifier specification, representing dependencies required to execute the build system.",
"markdownDescription": "List of strings following the [version specifier specification](https://packaging.python.org/en/latest/specifications/version-specifiers/#version-specifiers), representing dependencies required to execute the build system.",
"x-intellij-html-description": "<p>List of strings following the <a href=\"https://packaging.python.org/en/latest/specifications/version-specifiers/#version-specifiers\">version specifier specification</a>, representing dependencies required to execute the build system.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#declaring-build-system-dependencies-the-build-system-table"
}
},
"examples": ["setuptools >= 64.0"]
},
"build-backend": {
"type": "string",
"title": "Name of Python object used to perform the build",
"description": "String is formatted following the same `module:object` syntax as a `setuptools` entry point. It’s also legal to leave out the `:object` part.",
"markdownDescription": "String is formatted following the same `module:object` syntax as a `setuptools` entry point. It’s also legal to leave out the `:object` part.",
"x-intellij-html-description": "<p>String is formatted following the same <code>module:object</code> syntax as a <code>setuptools</code> entry point. It’s also legal to leave out the <code>:object</code> part.</p>",
"x-taplo": {
"links": {
"key": "https://peps.python.org/pep-0517/#source-trees"
}
},
"examples": ["setuptools.build_meta", "my_build_backend:backend"]
},
"backend-path": {
"type": "array",
"items": {
"type": "string"
},
"title": "Build backend directories",
"description": "list of directories to prepend to `sys.path` when loading the build backend, relative to project root",
"markdownDescription": "list of directoriesrepend to `sys.path` when loading the build backend, relative to project root",
"x-intellij-html-description": "<p>list of directories to prepend to <code>sys.path</code> when loading the build backend, relative to project root</p>",
"x-taplo": {
"links": {
"key": "https://peps.python.org/pep-0517/#in-tree-build-backends"
}
}
}
}
}
},
"properties": {
"build-system": {
"$ref": "#/definitions/BuildSystem"
},
"tool": {
"type": "object",
"additionalProperties": {
"type": "object"
},
"title": "Tool-specific configuration",
"description": "Every tool that is used by the project can have users specify configuration data as long as they use a sub-table within `[tool]`. Generally a project can use the subtable `tool.$NAME` if, and only if, they own the entry for `$NAME` in the Cheeseshop/PyPI.",
"markdownDescription": "Every tool that is used by the project can have users specify configuration data as long as they use a sub-table within `[tool]`. Generally a project can use the subtable `tool.$NAME` if, and only if, they own the entry for `$NAME` in the Cheeseshop/PyPI.",
"x-intellij-html-description": "<p>Every tool that is used by the project can have users specify configuration data as long as they use a sub-table within <code>[tool]</code>. Generally a project can use the subtable <code>tool.$NAME</code> if, and only if, they own the entry for <code>$NAME</code> in the Cheeseshop/PyPI.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#arbitrary-tool-configuration-the-tool-table"
}
},
"properties": {
"black": {
"$ref": "https://json.schemastore.org/partial-black.json"
},
"cibuildwheel": {
"$ref": "https://json.schemastore.org/partial-cibuildwheel.json"
},
"mypy": {
"$ref": "https://json.schemastore.org/partial-mypy.json"
},
"ruff": {
"$ref": "https://json.schemastore.org/ruff.json"
},
"hatch": {
"$ref": "https://json.schemastore.org/hatch.json"
},
"scikit-build": {
"$ref": "https://json.schemastore.org/partial-scikit-build.json"
},
"setuptools": {
"$ref": "https://json.schemastore.org/partial-setuptools.json"
},
"setuptools_scm": {
"$ref": "https://json.schemastore.org/partial-setuptools-scm.json"
},
"poetry": {
"$ref": "https://json.schemastore.org/partial-poetry.json"
},
"pdm": {
"$ref": "https://json.schemastore.org/partial-pdm.json"
},
"pyright": {
"$ref": "https://json.schemastore.org/partial-pyright.json"
},
"tox": {
"$ref": "https://json.schemastore.org/partial-tox.json"
},
"uv": {
"$ref": "https://json.schemastore.org/uv.json"
}
},
"examples": [
{
"tool": {
"isort": {
"profile": "black"
}
}
}
]
},
"project": {
"type": "object",
"additionalProperties": false,
"required": ["name"],
"title": "Project core metadata",
"description": "There are two kinds of metadata: _static_ and _dynamic_.\n- Static metadata is listed in the `[project]` table directly and cannot be specified or changed by a tool.\n- Dynamic metadata key names are listed inside the `dynamic` key and represents metadata that a tool will later provide.",
"markdownDescription": "There are two kinds of metadata: _static_ and _dynamic_.\n- Static metadata is listed in the `[project]` table directly and cannot be specified or changed by a tool.\n- Dynamic metadata key names are listed inside the `dynamic` key and represents metadata that a tool will later provide.",
"x-intellij-html-description": "<p>There are two kinds of metadata: <em>static</em> and <em>dynamic</em>.</p><ul><li>Static metadata is listed in the <code>[project]</code> table directly and cannot be specified or changed by a tool.</li><li>Dynamic metadata key names are listed inside the <code>dynamic</code> key and represents metadata that a tool will later provide.</li></ul>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#declaring-project-metadata-the-project-table",
"initKeys": [
"name",
"version",
"description",
"readme",
"license",
"authors",
"classifiers",
"urls",
"dependencies"
]
}
},
"properties": {
"name": {
"title": "Project name",
"description": "Valid name consists only of ASCII letters and numbers, period, underscore and hyphen. It must start and end with a letter or number.",
"markdownDescription": "Valid name consists only of ASCII letters and numbers, period, underscore and hyphen. It must start and end with a letter or number.",
"x-intellij-html-description": "<p>Valid name consists only of ASCII letters and numbers, period, underscore and hyphen. It must start and end with a letter or number.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#name"
}
},
"type": "string",
"pattern": "^([a-zA-Z\\d]|[a-zA-Z\\d][\\w.-]*[a-zA-Z\\d])$"
},
"version": {
"type": "string",
"pattern": "^v?((([0-9]+)!)?([0-9]+(\\.[0-9]+)*)([-_\\.]?(alpha|a|beta|b|preview|pre|c|rc)[-_\\.]?([0-9]+)?)?((-([0-9]+))|([-_\\.]?(post|rev|r)[-_\\.]?([0-9]+)?))?([-_\\.]?(dev)[-_\\.]?([0-9]+)?)?)(\\+([a-z0-9]+([-_\\.][a-z0-9]+)*))?$",
"title": "Project version",
"description": "Version of the project, as defined in the [Version specifier specification](https://packaging.python.org/en/latest/specifications/version-specifiers/), and preferably [already normalized](https://packaging.python.org/en/latest/specifications/version-specifiers/#normalization).",
"markdownDescription": "Version of the project, as defined in the [Version specifier specification](https://packaging.python.org/en/latest/specifications/version-specifiers/), and preferably [already normalized](https://packaging.python.org/en/latest/specifications/version-specifiers/#normalization).",
"x-intellij-html-description": "<p>Version of the project, as defined in the <a href=\"https://packaging.python.org/en/latest/specifications/version-specifiers/\">Version specifier specification</a>, and preferably <a href=\"https://packaging.python.org/en/latest/specifications/version-specifiers/#normalization\">already normalized</a>.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#version"
}
},
"examples": ["42.0.1", "0.3.9rc7.post0.dev5"]
},
"description": {
"type": "string",
"title": "Project summary description",
"description": "Summary description of the project in one line. Tools may not accept multiple lines.",
"markdownDescription": "Summary description of the project in one line. Tools may not accept multiple lines.",
"x-intellij-html-description": "<p>Summary description of the project in one line. Tools may not accept multiple lines.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#description"
}
}
},
"readme": {
"title": "Project full description",
"description": "Value can be a relative path to text / markdown (`.md` suffix) / reStructuredText (`.rst` suffix) readme file, or a table with either:\n- `file` key containing path of aforementioned readme file, or\n- `text` key containing the full readme text embedded inside `pyproject.toml`.",
"markdownDescription": "Value can be a relative path to text / markdown (`.md` suffix) / reStructuredText (`.rst` suffix) readme file, or a table with either:\n- `file` key containing path of aforementioned readme file, or\n- `text` key containing the full readme text embedded inside `pyproject.toml`.",
"x-intellij-html-description": "<p>Value can be a relative path to text / markdown (<code>.md</code> suffix) / reStructuredText (<code>.rst</code> suffix) readme file, or a table with either:</p><ul><li><code>file</code> key containing path of aforementioned readme file, or</li><li><code>text</code> key containing the full readme text embedded inside <code>pyproject.toml</code>.</li></ul>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#readme"
}
},
"oneOf": [
{
"title": "README file path",
"type": "string"
},
{
"type": "object",
"required": ["content-type"],
"properties": {
"content-type": {
"title": "README text content-type",
"description": "RFC 1341 compliant content-type (with optional charset, defaulting to UTF-8)",
"type": "string"
}
},
"oneOf": [
{
"additionalProperties": false,
"required": ["file"],
"properties": {
"content-type": true,
"file": {
"title": "README file path",
"type": "string"
}
}
},
{
"additionalProperties": false,
"required": ["text"],
"properties": {
"content-type": true,
"text": {
"title": "README text",
"type": "string"
}
}
}
]
}
],
"examples": [
"README.md",
{
"file": "README.txt",
"content-type": "text/plain"
},
{
"text": "# Example project\n\nSome readme content",
"content-type": "text/markdown"
}
]
},
"requires-python": {
"type": "string",
"title": "Python version compatibility",
"description": "Specifies the Python version(s) that the distribution is compatible with. Must be in the format specified in [Version specifiers](https://packaging.python.org/en/latest/specifications/version-specifiers/).",
"markdownDescription": "Specifies the Python version(s) that the distribution is compatible with. Must be in the format specified in [Version specifiers](https://packaging.python.org/en/latest/specifications/version-specifiers/).",
"x-intellij-html-description": "<p>Specifies the Python version(s) that the distribution is compatible with. Must be in the format specified in <a href=\"https://packaging.python.org/en/latest/specifications/version-specifiers/\">Version specifiers</a>.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#requires-python"
}
},
"examples": [">= 3.7"]
},
"license": {
"$comment": "PEP 639 specifies current behavior (text / file subkey) will be deprecated, but this PEP is still under provisional status.",
"title": "Project license",
"description": "For now it is a table with either:\n- `file` key specifying a relative path to a license file, or\n- `text` key containing full license content\n\nNewer tool may accept a single [SPDX license expression](https://spdx.github.io/spdx-spec/v2.2.2/SPDX-license-expressions/) string instead of a table.",
"markdownDescription": "For now it is a table with either:\n- `file` key specifying a relative path to a license file, or\n- `text` key containing full license content\n\nNewer tool may accept a single [SPDX license expression](https://spdx.github.io/spdx-spec/v2.2.2/SPDX-license-expressions/) string instead of a table.",
"x-intellij-html-description": "<p>For now it is a table with either:</p><ul><li><code>file</code> key specifying a relative path to a license file, or</li><li><code>text</code> key containing full license content</li></ul><p>Newer tool may accept a single <a href=\"https://spdx.github.io/spdx-spec/v2.2.2/SPDX-license-expressions/\">SPDX license expression</a> string instead of a table.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#license"
}
},
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"required": ["file"],
"properties": {
"file": {
"title": "License file path",
"type": "string"
}
}
},
{
"type": "object",
"additionalProperties": false,
"required": ["text"],
"properties": {
"text": {
"title": "License text",
"type": "string"
}
}
},
{
"$comment": "Maybe add 'deprecated' keyword to table usage when SPDX license expression usage is finalized. But that requires 2019-09 draft.",
"type": "string"
}
],
"examples": [
{
"text": "To the extent possible under law, the author(s) who associated this software with CC0 have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty."
},
{
"file": "LICENSE"
},
"MIT",
"BSD-2-Clause OR Apache-2.0",
"LicenseRef-Proprietary"
]
},
"license-files": {
"$comment": "Still provisional under PEP 639",
"type": "array",
"items": {
"type": "string"
},
"title": "License files",
"description": "Relative paths or globs to paths of license files. Can be an empty list.",
"markdownDescription": "Relative paths or globs to paths of license files. Can be an empty list.",
"x-intellij-html-description": "<p>Relative paths or globs to paths of license files. Can be an empty list.</p>",
"x-taplo": {
"links": {
"key": "https://peps.python.org/pep-0639/#add-license-files-key"
}
}
},
"authors": {
"type": "array",
"items": {
"$ref": "#/definitions/projectAuthor"
},
"title": "Project authors",
"description": "People or organizations considered as 'authors' of the project. Each author is a table with `name` key, `email` key, or both.",
"markdownDescription": "People or organizations considered as 'authors' of the project. Each author is a table with `name` key, `email` key, or both.",
"x-intellij-html-description": "<p>People or organizations considered as 'authors' of the project. Each author is a table with <code>name</code> key, <code>email</code> key, or both.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#authors-maintainers"
}
}
},
"maintainers": {
"type": "array",
"items": {
"$ref": "#/definitions/projectAuthor"
},
"title": "Project maintainers",
"description": "People or organizations considered as 'maintainers' of the project. Each maintainer is a table with `name` key, `email` key, or both.",
"markdownDescription": "People or organizations considered as 'maintainers' of the project. Each maintainer is a table with `name` key, `email` key, or both.",
"x-intellij-html-description": "<p>People or organizations considered as 'maintainers' of the project. Each maintainer is a table with <code>name</code> key, <code>email</code> key, or both.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#authors-maintainers"
}
}
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"title": "Project keywords",
"description": "List of keywords or tags that describe the project. They could be used by search engines to categorize the project.",
"markdownDescription": "List of keywords or tags that describe the project. They could be used by search engines to categorize the project.",
"x-intellij-html-description": "<p>List of keywords or tags that describe the project. They could be used by search engines to categorize the project.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#keywords"
}
}
},
"classifiers": {
"type": "array",
"items": {
"type": "string"
},
"title": "Applicable Trove classifiers",
"description": "List of [Trove classifiers](https://pypi.org/classifiers/) that describe the project. PyPI use the classifiers to categorize projects.",
"markdownDescription": "List of [Trove classifiers](https://pypi.org/classifiers/) that describe the project. PyPI use the classifiers to categorize projects.",
"x-intellij-html-description": "<p>List of <a href=\"https://pypi.org/classifiers/\">Trove classifiers</a> that describe the project. PyPI use the classifiers to categorize projects.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#classifiers"
}
}
},
"urls": {
"type": "object",
"additionalProperties": {
"type": "string",
"format": "uri"
},
"title": "Project URLs",
"description": "Table consisting one or multiple `label: URL` pairs. Common indexes like PyPI uses [well-known Project URLs](https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels) when presenting project pages.",
"markdownDescription": "Table consisting one or multiple `label: URL` pairs. Common indexes like PyPI uses [well-known Project URLs](https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels) when presenting project pages.",
"x-intellij-html-description": "<p>Table consisting one or multiple <code>label: URL</code> pairs. Common indexes like PyPI uses <a href=\"https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels\">well-known Project URLs</a> when presenting project pages.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#urls"
}
},
"examples": [
{ "homepage": "https://example.com/example-project" },
{
"\"home page\"": "https://example.com/example-project",
"documentation": "https://doc.example.com/example-project/stable",
"repository": "https://git.example.com/some/repo.git"
}
]
},
"scripts": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"title": "Console scripts",
"description": "Table of [entry points](https://packaging.python.org/en/latest/specifications/entry-points/) that allows package installers to create a command-line wrapper for. Each key is the name of the script to be created, and each value is the function or object to all, in form of either `importable.module` or `importable.module:object.attr`. Windows platform treats `console_scripts` specially in that they are wrapped in a console executable, so they are attached to a console and can use `sys.stdin`, `sys.stdout` and `sys.stderr` for I/O.",
"markdownDescription": "Table of [entry points](https://packaging.python.org/en/latest/specifications/entry-points/) that allows package installers to create a command-line wrapper for. Each key is the name of the script to be created, and each value is the function or object to all, in form of either `importable.module` or `importable.module:object.attr`. Windows platform treats `console_scripts` specially in that they are wrapped in a console executable, so they are attached to a console and can use `sys.stdin`, `sys.stdout` and `sys.stderr` for I/O.",
"x-intellij-html-description": "<p>Table of <a href=\"https://packaging.python.org/en/latest/specifications/entry-points/\">entry points</a> that allows package installers to create a command-line wrapper for. Each key is the name of the script to be created, and each value is the function or object to all, in form of either <code>importable.module</code> or <code>importable.module:object.attr</code>. Windows platform treats <code>console_scripts</code> specially in that they are wrapped in a console executable, so they are attached to a console and can use <code>sys.stdin</code>, <code>sys.stdout</code> and <code>sys.stderr</code> for I/O.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/entry-points/#use-for-scripts"
}
},
"examples": [
{
"mycmd": "package.module:object.function"
}
]
},
"gui-scripts": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"title": "GUI scripts",
"description": "Table of [entry points](https://packaging.python.org/en/latest/specifications/entry-points/) that allows package installers to create a GUI wrapper for. Each key is the name of the script to be created, and each value is the function or object to all, in form of either `importable.module` or `importable.module:object.attr`. Windows platform treats `gui_scripts` specially in that they are wrapped in a GUI executable, so they can be started without a console, but cannot use standard streams unless application code redirects them.",
"markdownDescription": "Table of [entry points](https://packaging.python.org/en/latest/specifications/entry-points/) that allows package installers to create a GUI wrapper for. Each key is the name of the script to be created, and each value is the function or object to all, in form of either `importable.module` or `importable.module:object.attr`. Windows platform treats `gui_scripts` specially in that they are wrapped in a GUI executable, so they can be started without a console, but cannot use standard streams unless application code redirects them.",
"x-intellij-html-description": "<p>Table of <a href=\"https://packaging.python.org/en/latest/specifications/entry-points/\">entry points</a> that allows package installers to create a GUI wrapper for. Each key is the name of the script to be created, and each value is the function or object to all, in form of either <code>importable.module</code> or <code>importable.module:object.attr</code>. Windows platform treats <code>gui_scripts</code> specially in that they are wrapped in a GUI executable, so they can be started without a console, but cannot use standard streams unless application code redirects them.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/entry-points/#use-for-scripts"
}
},
"examples": [
{
"mycmd": "package.module:object.function"
}
]
},
"entry-points": {
"type": "object",
"additionalProperties": false,
"patternProperties": {
"^\\w+(\\.\\w+)*$": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"propertyNames": {
"not": {
"anyOf": [
{
"const": "console_scripts"
},
{
"const": "gui_scripts"
}
]
}
},
"title": "Other entry-point groups",
"description": "Extra [entry point groups](https://packaging.python.org/en/latest/specifications/entry-points/) that allow applications to load plugins. For example, Pygments (a syntax highlighting tool) can use additional styles from separately installed packages through `[project.entry-points.\"pygments.styles\"]`. Each key is the name of the entry-point group, and each value is a table of entry points.",
"markdownDescription": "Extra [entry point groups](https://packaging.python.org/en/latest/specifications/entry-points/) that allow applications to load plugins. For example, Pygments (a syntax highlighting tool) can use additional styles from separately installed packages through `[project.entry-points.\"pygments.styles\"]`. Each key is the name of the entry-point group, and each value is a table of entry points.",
"x-intellij-html-description": "<p>Extra <a href=\"https://packaging.python.org/en/latest/specifications/entry-points/\">entry point groups</a> that allow applications to load plugins. For example, Pygments (a syntax highlighting tool) can use additional styles from separately installed packages through <code>[project.entry-points.\"pygments.styles\"]</code>. Each key is the name of the entry-point group, and each value is a table of entry points.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/entry-points/#use-for-plugins"
}
},
"examples": [
{
"pygments.styles": {
"monokai": "package.module:object.attribute"
}
}
]
},
"dependencies": {
"type": "array",
"items": {
"type": "string"
},
"title": "Project mandatory dependency requirements",
"description": "An array of [dependency specifier](https://packaging.python.org/en/latest/specifications/dependency-specifiers/) strings, each representing a mandatory dependent package of the project.",
"markdownDescription": "An array of [dependency specifier](https://packaging.python.org/en/latest/specifications/dependency-specifiers/) strings, each representing a mandatory dependent package of the project.",
"x-intellij-html-description": "<p>An array of <a href=\"https://packaging.python.org/en/latest/specifications/dependency-specifiers/\">dependency specifier</a> strings, each representing a mandatory dependent package of the project.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#dependencies-optional-dependencies"
}
},
"examples": [["attrs", "requests ~= 2.28"]]
},
"optional-dependencies": {
"type": "object",
"patternProperties": {
"^([a-z\\d]|[a-z\\d]([a-z\\d-](?!--))*[a-z\\d])$": {
"type": "array",
"items": {
"type": "string"
}
}
},
"title": "Project extra dependency requirements",
"description": "Each entry is a key/value pair, with the key specifying [extra feature name](https://packaging.python.org/en/latest/specifications/core-metadata/#provides-extra-multiple-use) (such as `socks` in `requests[socks]`), and value is an array of [dependency specifier](https://packaging.python.org/en/latest/specifications/dependency-specifiers/) strings.",
"markdownDescription": "Each entry is a key/value pair, with the key specifying [extra feature name](https://packaging.python.org/en/latest/specifications/core-metadata/#provides-extra-multiple-use) (such as `socks` in `requests[socks]`), and value is an array of [dependency specifier](https://packaging.python.org/en/latest/specifications/dependency-specifiers/) strings.",
"x-intellij-html-description": "<p>Each entry is a key/value pair, with the key specifying <a href=\"https://packaging.python.org/en/latest/specifications/core-metadata/#provides-extra-multiple-use\">extra feature name</a> (such as <code>socks</code> in <code>requests[socks]</code>), and value is an array of <a href=\"https://packaging.python.org/en/latest/specifications/dependency-specifiers/\">dependency specifier</a> strings.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#dependencies-optional-dependencies"
}
},
"examples": [
{
"typing": ["boto3-stubs", "typing-extensions ~= 4.1"]
}
]
},
"dynamic": {
"type": "array",
"items": {
"type": "string",
"enum": [
"version",
"description",
"readme",
"requires-python",
"license",
"license-files",
"authors",
"maintainers",
"keywords",
"classifiers",
"urls",
"scripts",
"gui-scripts",
"entry-points",
"dependencies",
"optional-dependencies"
]
},
"title": "Dynamic metadata values",
"description": "Specifies which keys are intentionally unspecified under `[project]` table so build backend can/will provide such metadata dynamically. Each key must be listed only once. It is an error to both list a key in `dynamic` and use the key directly in `[project]`.\nOne of the most common usage is `version`, which allows build backend to retrieve project version from source code or version control system instead of hardcoding it in `pyproject.toml`.",
"markdownDescription": "Specifies which keys are intentionally unspecified under `[project]` table so build backend can/will provide such metadata dynamically. Each key must be listed only once. It is an error to both list a key in `dynamic` and use the key directly in `[project]`.\nOne of the most common usage is `version`, which allows build backend to retrieve project version from source code or version control system instead of hardcoding it in `pyproject.toml`.",
"x-intellij-html-description": "<p>Specifies which keys are intentionally unspecified under <code>[project]</code> table so build backend can/will provide such metadata dynamically. Each key must be listed only once. It is an error to both list a key in <code>dynamic</code> and use the key directly in <code>[project]</code>.</p><p>One of the most common usage is <code>version</code>, which allows build backend to retrieve project version from source code or version control system instead of hardcoding it in <code>pyproject.toml</code>.</p>",
"x-taplo": {
"links": {
"key": "https://packaging.python.org/en/latest/specifications/pyproject-toml/#dynamic"
}
},
"examples": [["version"]]
}
},
"oneOf": [
{
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "version"
}
}
}
},
{
"required": ["version"],
"properties": {
"version": true
}
}
],
"dependencies": {
"version": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "version"
}
}
}
}
},
"description": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "description"
}
}
}
}
},
"readme": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "readme"
}
}
}
}
},
"requires-python": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "requires-python"
}
}
}
}
},
"license": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "license"
}
}
}
}
},
"license-files": {
"allOf": [
{
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "license-files"
}
}
}
}
},
{
"properties": {
"license": {
"type": "string"
}
}
}
]
},
"authors": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "authors"
}
}
}
}
},
"maintainers": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "maintainers"
}
}
}
}
},
"keywords": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "keywords"
}
}
}
}
},
"classifiers": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "classifiers"
}
}
}
}
},
"urls": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "urls"
}
}
}
}
},
"scripts": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "scripts"
}
}
}
}
},
"gui-scripts": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "gui-scripts"
}
}
}
}
},
"entry-points": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "entry-points"
}
}
}
}
},
"dependencies": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "dependencies"
}
}
}
}
},
"optional-dependencies": {
"not": {
"required": ["dynamic"],
"properties": {
"dynamic": {
"type": "array",
"contains": {
"const": "optional-dependencies"
}
}
}
}
}
}
},
"dependency-groups": {
"title": "PEP 735 dependency groups",
"description": "Named groups of dependencies, similar to `requirements.txt` files, which launchers, IDEs, and other tools can find and identify by name. Each item in `[dependency-groups]` is defined as mapping of group name to list of [dependency specifiers](https://packaging.python.org/en/latest/specifications/dependency-specifiers/).",
"markdownDescription": "Named groups of dependencies, similar to `requirements.txt` files, which launchers, IDEs, and other tools can find and identify by name. Each item in `[dependency-groups]` is defined as mapping of group name to list of [dependency specifiers](https://packaging.python.org/en/latest/specifications/dependency-specifiers/).",
"x-intellij-html-description": "<p>Named groups of dependencies, similar to <code>requirements.txt</code> files, which launchers, IDEs, and other tools can find and identify by name. Each item in <code>[dependency-groups]</code> is defined as mapping of group name to list of <a href=\"https://packaging.python.org/en/latest/specifications/dependency-specifiers/\">dependency specifiers</a>.</p>",
"x-taplo": {
"links": {
"key": "https://peps.python.org/pep-0735/"
}
},
"type": "object",
"additionalProperties": false,
"patternProperties": {
"^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9._-]*[a-zA-Z0-9])$": {
"type": "array",
"title": "Dependency specifiers or include groups",
"description": "Each list item should be either:\n- [dependency specifiers](https://packaging.python.org/en/latest/specifications/dependency-specifiers/), or\n- table with a single key `include-group` which specifies another group name to include into this one",
"markdownDescription": "Each list item should be either:\n- [dependency specifiers](https://packaging.python.org/en/latest/specifications/dependency-specifiers/), or\n- table with a single key `include-group` which specifies another group name to include into this one",
"x-intellij-html-description": "<p>Each list item should be either:</p><ul><li><a href=\"https://packaging.python.org/en/latest/specifications/dependency-specifiers/\">dependency specifiers</a>, or</li><li>table with a single key <code>include-group</code> which specifies another group name to include into this one</li></ul>",
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"include-group": {
"type": "string",
"pattern": "^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9._-]*[a-zA-Z0-9])$"
}
}
}
]
}
}
}
}
},
"title": "JSON schema for Python project metadata and configuration",
"type": "object",
"x-taplo-info": {
"authors": ["zevisert (https://github.com/zevisert)"],
"pattern": ["^(.*(/|\\\\)pyproject\\.toml|pyproject\\.toml)$"]
}
}