forked from scverse/ecosystem-packages
-
Notifications
You must be signed in to change notification settings - Fork 0
/
schema.json
233 lines (233 loc) · 7.5 KB
/
schema.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
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/scverse/ecosystem-packages/main/schema.json",
"title": "Scverse Ecosystem Packages",
"description": "An approved scverse ecosystem package that fulfils some minimal requirements",
"type": "object",
"properties": {
"name": {
"description": "The name of the package. Must be unique",
"type": "string"
},
"description": {
"description": "Summary of the purpose of the package (1-2 sentences).",
"type": "string"
},
"project_home": {
"description": "Link to the source code of the project (Usually a GitHub project page)",
"type": "string",
"format": "uri"
},
"documentation_home": {
"descripton": "Link to the documentation of the package (e.g. readthedocs)",
"type": "string",
"format": "uri"
},
"tutorials_home": {
"descripton": "Link to the tutorials/vignette (often a subpage of the documentation)",
"type": "string",
"format": "uri"
},
"install": {
"type": "object",
"items": {
"properties": {
"pypi": {
"description": "PyPI identifier",
"type": "string"
},
"conda": {
"description": "Conda identifier, including channel (e.g. conda-forge::scanpy)",
"type": "string",
"pattern": "(.*)::(.*)"
},
"cran": {
"description": "CRAN identifier",
"type": "string"
}
}
},
"minItems": 1
},
"license": {
"description": "The license of the code. Must be a OSI-approved SPDX license identifier (see https://spdx.org/licenses/)",
"comment": "import pandas as pd; from json import dumps; dumps(pd.read_html('https://spdx.org/licenses/')[0].loc[lambda x: x['OSI Approved?'] == 'Y']['Identifier'].tolist())",
"type": "string",
"enum": [
"0BSD",
"AAL",
"AFL-1.1",
"AFL-1.2",
"AFL-2.0",
"AFL-2.1",
"AFL-3.0",
"AGPL-3.0-only",
"AGPL-3.0-or-later",
"Apache-1.1",
"Apache-2.0",
"APL-1.0",
"APSL-1.0",
"APSL-1.1",
"APSL-1.2",
"APSL-2.0",
"Artistic-1.0",
"Artistic-1.0-cl8",
"Artistic-1.0-Perl",
"Artistic-2.0",
"BSD-1-Clause",
"BSD-2-Clause",
"BSD-2-Clause-Patent",
"BSD-3-Clause",
"BSD-3-Clause-LBNL",
"BSL-1.0",
"CAL-1.0",
"CAL-1.0-Combined-Work-Exception",
"CATOSL-1.1",
"CDDL-1.0",
"CECILL-2.1",
"CERN-OHL-P-2.0",
"CERN-OHL-S-2.0",
"CERN-OHL-W-2.0",
"CNRI-Python",
"CPAL-1.0",
"CPL-1.0",
"CUA-OPL-1.0",
"ECL-1.0",
"ECL-2.0",
"EFL-1.0",
"EFL-2.0",
"Entessa",
"EPL-1.0",
"EPL-2.0",
"EUDatagrid",
"EUPL-1.1",
"EUPL-1.2",
"Fair",
"Frameworx-1.0",
"GPL-2.0-only",
"GPL-2.0-or-later",
"GPL-3.0-only",
"GPL-3.0-or-later",
"HPND",
"Intel",
"IPA",
"IPL-1.0",
"ISC",
"Jam",
"LGPL-2.0-only",
"LGPL-2.0-or-later",
"LGPL-2.1-only",
"LGPL-2.1-or-later",
"LGPL-3.0-only",
"LGPL-3.0-or-later",
"LiLiQ-P-1.1",
"LiLiQ-R-1.1",
"LiLiQ-Rplus-1.1",
"LPL-1.0",
"LPL-1.02",
"LPPL-1.3c",
"MirOS",
"MIT",
"MIT-0",
"MIT-Modern-Variant",
"Motosoto",
"MPL-1.0",
"MPL-1.1",
"MPL-2.0",
"MPL-2.0-no-copyleft-exception",
"MS-PL",
"MS-RL",
"MulanPSL-2.0",
"Multics",
"NASA-1.3",
"Naumen",
"NCSA",
"NGPL",
"Nokia",
"NPOSL-3.0",
"NTP",
"OCLC-2.0",
"OFL-1.1",
"OFL-1.1-no-RFN",
"OFL-1.1-RFN",
"OGTSL",
"OLDAP-2.8",
"OSET-PL-2.1",
"OSL-1.0",
"OSL-2.0",
"OSL-2.1",
"OSL-3.0",
"PHP-3.0",
"PHP-3.01",
"PostgreSQL",
"Python-2.0",
"QPL-1.0",
"RPL-1.1",
"RPL-1.5",
"RPSL-1.0",
"RSCPL",
"SimPL-2.0",
"SISSL",
"Sleepycat",
"SPL-1.0",
"UCL-1.0",
"Unicode-DFS-2016",
"Unlicense",
"UPL-1.0",
"VSL-1.0",
"W3C",
"Watcom-1.0",
"Xnet",
"Zlib",
"ZPL-2.0",
"ZPL-2.1"
]
},
"tags": {
"description": "Keywords that describe the package",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
},
"publications": {
"description": "DOIs of publications describing the package",
"type": "array",
"items": {
"type": "string",
"comment": "DOI regex from https://www.crossref.org/blog/dois-and-matching-regular-expressions/",
"pattern": "^10.\\d{4,9}\\/[-._;()\\/:A-Za-z0-9]+$"
}
},
"version": {
"description": "The version of the package at the point when this entry was created or updated",
"type": "string"
},
"authors": {
"description": "List of authors/maintainers of the package. Entries must be Github user IDs.",
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"uniqueItems": true
},
"test_command": {
"description": "A shell command to install the package and execute the tests, assuming you are inside a freshly cloned copy of the package repository. Often this will be `pip install \".[test]\" && pytest`",
"type": ["string", "null"]
}
},
"required": [
"name",
"description",
"project_home",
"documentation_home",
"install",
"license",
"tags",
"version",
"authors"
]
}