galaxy-schema 23.2.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. galaxy-schema-23.2.1/HISTORY.rst +10 -0
  2. galaxy-schema-23.2.1/LICENSE +228 -0
  3. galaxy-schema-23.2.1/MANIFEST.in +1 -0
  4. galaxy-schema-23.2.1/PKG-INFO +52 -0
  5. galaxy-schema-23.2.1/README.rst +14 -0
  6. galaxy-schema-23.2.1/dev-requirements.txt +10 -0
  7. galaxy-schema-23.2.1/galaxy/__init__.py +1 -0
  8. galaxy-schema-23.2.1/galaxy/py.typed +0 -0
  9. galaxy-schema-23.2.1/galaxy/schema/__init__.py +115 -0
  10. galaxy-schema-23.2.1/galaxy/schema/bco/__init__.py +97 -0
  11. galaxy-schema-23.2.1/galaxy/schema/bco/description_domain.py +133 -0
  12. galaxy-schema-23.2.1/galaxy/schema/bco/error_domain.py +32 -0
  13. galaxy-schema-23.2.1/galaxy/schema/bco/execution_domain.py +138 -0
  14. galaxy-schema-23.2.1/galaxy/schema/bco/io_domain.py +109 -0
  15. galaxy-schema-23.2.1/galaxy/schema/bco/parametric_domain.py +43 -0
  16. galaxy-schema-23.2.1/galaxy/schema/bco/provenance_domain.py +153 -0
  17. galaxy-schema-23.2.1/galaxy/schema/bco/usability_domain.py +20 -0
  18. galaxy-schema-23.2.1/galaxy/schema/bco/util.py +98 -0
  19. galaxy-schema-23.2.1/galaxy/schema/cloud.py +131 -0
  20. galaxy-schema-23.2.1/galaxy/schema/drs/AccessMethod.py +57 -0
  21. galaxy-schema-23.2.1/galaxy/schema/drs/AccessURL.py +24 -0
  22. galaxy-schema-23.2.1/galaxy/schema/drs/Checksum.py +19 -0
  23. galaxy-schema-23.2.1/galaxy/schema/drs/ContentsObject.py +38 -0
  24. galaxy-schema-23.2.1/galaxy/schema/drs/DrsObject.py +137 -0
  25. galaxy-schema-23.2.1/galaxy/schema/drs/DrsService.py +24 -0
  26. galaxy-schema-23.2.1/galaxy/schema/drs/Error.py +19 -0
  27. galaxy-schema-23.2.1/galaxy/schema/drs/Service.py +87 -0
  28. galaxy-schema-23.2.1/galaxy/schema/drs/__init__.py +23 -0
  29. galaxy-schema-23.2.1/galaxy/schema/fetch_data.py +282 -0
  30. galaxy-schema-23.2.1/galaxy/schema/fields.py +141 -0
  31. galaxy-schema-23.2.1/galaxy/schema/groups.py +68 -0
  32. galaxy-schema-23.2.1/galaxy/schema/help.py +112 -0
  33. galaxy-schema-23.2.1/galaxy/schema/invocation.py +220 -0
  34. galaxy-schema-23.2.1/galaxy/schema/item_tags.py +48 -0
  35. galaxy-schema-23.2.1/galaxy/schema/jobs.py +236 -0
  36. galaxy-schema-23.2.1/galaxy/schema/notifications.py +486 -0
  37. galaxy-schema-23.2.1/galaxy/schema/remote_files.py +187 -0
  38. galaxy-schema-23.2.1/galaxy/schema/schema.py +3648 -0
  39. galaxy-schema-23.2.1/galaxy/schema/storage_cleaner.py +69 -0
  40. galaxy-schema-23.2.1/galaxy/schema/tasks.py +123 -0
  41. galaxy-schema-23.2.1/galaxy/schema/types.py +24 -0
  42. galaxy-schema-23.2.1/galaxy/schema/visualization.py +103 -0
  43. galaxy-schema-23.2.1/galaxy/schema/workflow/__init__.py +0 -0
  44. galaxy-schema-23.2.1/galaxy/schema/workflow/comments.py +74 -0
  45. galaxy-schema-23.2.1/galaxy_schema.egg-info/PKG-INFO +52 -0
  46. galaxy-schema-23.2.1/galaxy_schema.egg-info/SOURCES.txt +51 -0
  47. galaxy-schema-23.2.1/galaxy_schema.egg-info/dependency_links.txt +1 -0
  48. galaxy-schema-23.2.1/galaxy_schema.egg-info/requires.txt +2 -0
  49. galaxy-schema-23.2.1/galaxy_schema.egg-info/top_level.txt +1 -0
  50. galaxy-schema-23.2.1/pyproject.toml +3 -0
  51. galaxy-schema-23.2.1/setup.cfg +46 -0
  52. galaxy-schema-23.2.1/test-requirements.txt +1 -0
@@ -0,0 +1,10 @@
1
+ History
2
+ -------
3
+
4
+ .. to_doc
5
+
6
+ -------------------
7
+ 23.2.1 (2024-02-21)
8
+ -------------------
9
+
10
+ First release
@@ -0,0 +1,228 @@
1
+ Copyright (c) 2005-2022 Galaxy Contributors (see CONTRIBUTORS.md)
2
+
3
+ Work contributed from 2021-04-07 onwards is licensed under the MIT License.
4
+ Work contributed before this date is licensed under the Academic Free License
5
+ version 3.0.
6
+ See https://github.com/galaxyproject/galaxy/ for the contribution history.
7
+ See below for the full text of both licenses.
8
+
9
+
10
+ Some icons found in Galaxy are from the Silk Icons set, available under
11
+ the Creative Commons Attribution 2.5 License, from:
12
+
13
+ http://www.famfamfam.com/lab/icons/silk/
14
+
15
+
16
+ Other images and documentation are licensed under the Creative Commons
17
+ Attribution 3.0 (CC BY 3.0) License. See:
18
+
19
+ http://creativecommons.org/licenses/by/3.0/
20
+
21
+
22
+ --------------------------------------------------------------------------------
23
+
24
+
25
+ MIT License
26
+
27
+ Permission is hereby granted, free of charge, to any person obtaining a copy
28
+ of this software and associated documentation files (the "Software"), to deal
29
+ in the Software without restriction, including without limitation the rights
30
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
31
+ copies of the Software, and to permit persons to whom the Software is
32
+ furnished to do so, subject to the following conditions:
33
+
34
+ The above copyright notice and this permission notice shall be included in all
35
+ copies or substantial portions of the Software.
36
+
37
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
38
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
39
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
40
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
41
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
42
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
43
+ SOFTWARE.
44
+
45
+
46
+ --------------------------------------------------------------------------------
47
+
48
+
49
+ Academic Free License ("AFL") v. 3.0
50
+
51
+ This Academic Free License (the "License") applies to any original work of
52
+ authorship (the "Original Work") whose owner (the "Licensor") has placed the
53
+ following licensing notice adjacent to the copyright notice for the Original
54
+ Work:
55
+
56
+ Licensed under the Academic Free License version 3.0
57
+
58
+ 1) Grant of Copyright License. Licensor grants You a worldwide, royalty-free,
59
+ non-exclusive, sublicensable license, for the duration of the copyright, to
60
+ do the following:
61
+
62
+ a) to reproduce the Original Work in copies, either alone or as part of a
63
+ collective work;
64
+
65
+ b) to translate, adapt, alter, transform, modify, or arrange the Original
66
+ Work, thereby creating derivative works ("Derivative Works") based upon
67
+ the Original Work;
68
+
69
+ c) to distribute or communicate copies of the Original Work and Derivative
70
+ Works to the public, under any license of your choice that does not
71
+ contradict the terms and conditions, including Licensor's reserved
72
+ rights and remedies, in this Academic Free License;
73
+
74
+ d) to perform the Original Work publicly; and
75
+
76
+ e) to display the Original Work publicly.
77
+
78
+ 2) Grant of Patent License. Licensor grants You a worldwide, royalty-free,
79
+ non-exclusive, sublicensable license, under patent claims owned or
80
+ controlled by the Licensor that are embodied in the Original Work as
81
+ furnished by the Licensor, for the duration of the patents, to make, use,
82
+ sell, offer for sale, have made, and import the Original Work and
83
+ Derivative Works.
84
+
85
+ 3) Grant of Source Code License. The term "Source Code" means the preferred
86
+ form of the Original Work for making modifications to it and all available
87
+ documentation describing how to modify the Original Work. Licensor agrees
88
+ to provide a machine-readable copy of the Source Code of the Original Work
89
+ along with each copy of the Original Work that Licensor distributes.
90
+ Licensor reserves the right to satisfy this obligation by placing a
91
+ machine-readable copy of the Source Code in an information repository
92
+ reasonably calculated to permit inexpensive and convenient access by You
93
+ for as long as Licensor continues to distribute the Original Work.
94
+
95
+ 4) Exclusions From License Grant. Neither the names of Licensor, nor the
96
+ names of any contributors to the Original Work, nor any of their
97
+ trademarks or service marks, may be used to endorse or promote products
98
+ derived from this Original Work without express prior permission of the
99
+ Licensor. Except as expressly stated herein, nothing in this License
100
+ grants any license to Licensor's trademarks, copyrights, patents, trade
101
+ secrets or any other intellectual property. No patent license is granted
102
+ to make, use, sell, offer for sale, have made, or import embodiments of
103
+ any patent claims other than the licensed claims defined in Section 2.
104
+ No license is granted to the trademarks of Licensor even if such marks
105
+ are included in the Original Work. Nothing in this License shall be
106
+ interpreted to prohibit Licensor from licensing under terms different
107
+ from this License any Original Work that Licensor otherwise would have a
108
+ right to license.
109
+
110
+ 5) External Deployment. The term "External Deployment" means the use,
111
+ distribution, or communication of the Original Work or Derivative Works
112
+ in any way such that the Original Work or Derivative Works may be used by
113
+ anyone other than You, whether those works are distributed or
114
+ communicated to those persons or made available as an application
115
+ intended for use over a network. As an express condition for the grants
116
+ of license hereunder, You must treat any External Deployment by You of
117
+ the Original Work or a Derivative Work as a distribution under
118
+ section 1(c).
119
+
120
+ 6) Attribution Rights. You must retain, in the Source Code of any Derivative
121
+ Works that You create, all copyright, patent, or trademark notices from
122
+ the Source Code of the Original Work, as well as any notices of licensing
123
+ and any descriptive text identified therein as an "Attribution Notice."
124
+ You must cause the Source Code for any Derivative Works that You create
125
+ to carry a prominent Attribution Notice reasonably calculated to inform
126
+ recipients that You have modified the Original Work.
127
+
128
+ 7) Warranty of Provenance and Disclaimer of Warranty. Licensor warrants that
129
+ the copyright in and to the Original Work and the patent rights granted
130
+ herein by Licensor are owned by the Licensor or are sublicensed to You
131
+ under the terms of this License with the permission of the contributor(s)
132
+ of those copyrights and patent rights. Except as expressly stated in the
133
+ immediately preceding sentence, the Original Work is provided under this
134
+ License on an "AS IS" BASIS and WITHOUT WARRANTY, either express or
135
+ implied, including, without limitation, the warranties of
136
+ non-infringement, merchantability or fitness for a particular purpose.
137
+ THE ENTIRE RISK AS TO THE QUALITY OF THE ORIGINAL WORK IS WITH YOU. This
138
+ DISCLAIMER OF WARRANTY constitutes an essential part of this License.
139
+ No license to the Original Work is granted by this License except under
140
+ this disclaimer.
141
+
142
+ 8) Limitation of Liability. Under no circumstances and under no legal
143
+ theory, whether in tort (including negligence), contract, or otherwise,
144
+ shall the Licensor be liable to anyone for any indirect, special,
145
+ incidental, or consequential damages of any character arising as a result
146
+ of this License or the use of the Original Work including, without
147
+ limitation, damages for loss of goodwill, work stoppage, computer failure
148
+ or malfunction, or any and all other commercial damages or losses. This
149
+ limitation of liability shall not apply to the extent applicable law
150
+ prohibits such limitation.
151
+
152
+ 9) Acceptance and Termination. If, at any time, You expressly assented to
153
+ this License, that assent indicates your clear and irrevocable acceptance
154
+ of this License and all of its terms and conditions. If You distribute or
155
+ communicate copies of the Original Work or a Derivative Work, You must
156
+ make a reasonable effort under the circumstances to obtain the express
157
+ assent of recipients to the terms of this License. This License
158
+ conditions your rights to undertake the activities listed in Section 1,
159
+ including your right to create Derivative Works based upon the Original
160
+ Work, and doing so without honoring these terms and conditions is
161
+ prohibited by copyright law and international treaty. Nothing in this
162
+ License is intended to affect copyright exceptions and limitations
163
+ (including "fair use" or "fair dealing"). This License shall terminate
164
+ immediately and You may no longer exercise any of the rights granted to
165
+ You by this License upon your failure to honor the conditions in
166
+ Section 1(c).
167
+
168
+ 10) Termination for Patent Action. This License shall terminate
169
+ automatically and You may no longer exercise any of the rights granted
170
+ to You by this License as of the date You commence an action, including
171
+ a cross-claim or counterclaim, against Licensor or any licensee alleging
172
+ that the Original Work infringes a patent. This termination provision
173
+ shall not apply for an action alleging patent infringement by
174
+ combinations of the Original Work with other software or hardware.
175
+
176
+ 11) Jurisdiction, Venue and Governing Law. Any action or suit relating to
177
+ this License may be brought only in the courts of a jurisdiction wherein
178
+ the Licensor resides or in which Licensor conducts its primary business,
179
+ and under the laws of that jurisdiction excluding its conflict-of-law
180
+ provisions. The application of the United Nations Convention on
181
+ Contracts for the International Sale of Goods is expressly excluded. Any
182
+ use of the Original Work outside the scope of this License or after its
183
+ termination shall be subject to the requirements and penalties of
184
+ copyright or patent law in the appropriate jurisdiction. This section
185
+ shall survive the termination of this License.
186
+
187
+ 12) Attorneys' Fees. In any action to enforce the terms of this License or
188
+ seeking damages relating thereto, the prevailing party shall be entitled
189
+ to recover its costs and expenses, including, without limitation,
190
+ reasonable attorneys' fees and costs incurred in connection with such
191
+ action, including any appeal of such action. This section shall survive
192
+ the termination of this License.
193
+
194
+ 13) Miscellaneous. If any provision of this License is held to be
195
+ unenforceable, such provision shall be reformed only to the extent
196
+ necessary to make it enforceable.
197
+
198
+ 14) Definition of "You" in This License. "You" throughout this License,
199
+ whether in upper or lower case, means an individual or a legal entity
200
+ exercising rights under, and complying with all of the terms of, this
201
+ License. For legal entities, "You" includes any entity that controls, is
202
+ controlled by, or is under common control with you. For purposes of this
203
+ definition, "control" means (i) the power, direct or indirect, to cause
204
+ the direction or management of such entity, whether by contract or
205
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
206
+ outstanding shares, or (iii) beneficial ownership of such entity.
207
+
208
+ 15) Right to Use. You may use the Original Work in all ways not otherwise
209
+ restricted or conditioned by this License or by law, and Licensor
210
+ promises not to interfere with or be responsible for such uses by You.
211
+
212
+ 16) Modification of This License. This License is Copyright © 2005 Lawrence
213
+ Rosen. Permission is granted to copy, distribute, or communicate this
214
+ License without modification. Nothing in this License permits You to
215
+ modify this License as applied to the Original Work or to Derivative
216
+ Works. However, You may modify the text of this License and copy,
217
+ distribute or communicate your modified version (the "Modified
218
+ License") and apply it to other original works of authorship subject to
219
+ the following conditions: (i) You may not indicate in any way that your
220
+ Modified License is the "Academic Free License" or "AFL" and you may not
221
+ use those names in the name of your Modified License; (ii) You must
222
+ replace the notice specified in the first paragraph above with the
223
+ notice "Licensed under <insert your license name here>" or with a notice
224
+ of your own that is not confusingly similar to the notice in this
225
+ License; and (iii) You may not claim that your original works are open
226
+ source software unless your Modified License has been approved by Open
227
+ Source Initiative (OSI) and You comply with its license review and
228
+ certification process.
@@ -0,0 +1 @@
1
+ include *.rst *.txt LICENSE */py.typed
@@ -0,0 +1,52 @@
1
+ Metadata-Version: 2.1
2
+ Name: galaxy-schema
3
+ Version: 23.2.1
4
+ Summary: Galaxy auth framework and implementations
5
+ Home-page: https://github.com/galaxyproject/galaxy
6
+ Author: Galaxy Project and Community
7
+ Author-email: galaxy-committers@lists.galaxyproject.org
8
+ License: AFL
9
+ Keywords: Galaxy
10
+ Classifier: Development Status :: 5 - Production/Stable
11
+ Classifier: Environment :: Console
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: License :: OSI Approved :: Academic Free License (AFL)
14
+ Classifier: Natural Language :: English
15
+ Classifier: Operating System :: POSIX
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.7
18
+ Classifier: Programming Language :: Python :: 3.8
19
+ Classifier: Programming Language :: Python :: 3.9
20
+ Classifier: Programming Language :: Python :: 3.10
21
+ Classifier: Topic :: Software Development
22
+ Classifier: Topic :: Software Development :: Code Generators
23
+ Classifier: Topic :: Software Development :: Testing
24
+ Requires-Python: >=3.7
25
+ Description-Content-Type: text/x-rst
26
+ License-File: LICENSE
27
+
28
+
29
+ .. image:: https://badge.fury.io/py/galaxy-schema.svg
30
+ :target: https://pypi.org/project/galaxy-schema/
31
+
32
+
33
+
34
+ Overview
35
+ --------
36
+
37
+ The Galaxy_ API schema objects.
38
+
39
+ * Code: https://github.com/galaxyproject/galaxy
40
+
41
+ .. _Galaxy: http://galaxyproject.org/
42
+
43
+ History
44
+ -------
45
+
46
+ .. to_doc
47
+
48
+ -------------------
49
+ 23.2.1 (2024-02-21)
50
+ -------------------
51
+
52
+ First release
@@ -0,0 +1,14 @@
1
+
2
+ .. image:: https://badge.fury.io/py/galaxy-schema.svg
3
+ :target: https://pypi.org/project/galaxy-schema/
4
+
5
+
6
+
7
+ Overview
8
+ --------
9
+
10
+ The Galaxy_ API schema objects.
11
+
12
+ * Code: https://github.com/galaxyproject/galaxy
13
+
14
+ .. _Galaxy: http://galaxyproject.org/
@@ -0,0 +1,10 @@
1
+ # For testing
2
+ -r test-requirements.txt
3
+
4
+ # For dev
5
+ sphinx
6
+ mypy
7
+
8
+ # For release
9
+ build
10
+ twine
@@ -0,0 +1 @@
1
+ __path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore[has-type]
File without changes
@@ -0,0 +1,115 @@
1
+ from datetime import datetime
2
+ from enum import Enum
3
+ from typing import (
4
+ Dict,
5
+ List,
6
+ Optional,
7
+ Union,
8
+ )
9
+
10
+ from pydantic import (
11
+ BaseModel,
12
+ Field,
13
+ Required,
14
+ )
15
+
16
+
17
+ class BootstrapAdminUser(BaseModel):
18
+ id = 0
19
+ email: Optional[str] = None
20
+ preferences: Dict[str, str] = {}
21
+ bootstrap_admin_user = True
22
+
23
+ def all_roles(*args) -> list:
24
+ return []
25
+
26
+
27
+ class ValueFilterQueryParams(BaseModel):
28
+ """Allows filtering/querying elements by value like `q=<property>-<operator>&qv=<value>`
29
+
30
+ Multiple `q/qv` queries can be concatenated.
31
+ """
32
+
33
+ q: Optional[Union[List[str], str]] = Field(
34
+ default=None,
35
+ title="Filter Query",
36
+ description="Generally a property name to filter by followed by an (often optional) hyphen and operator string.",
37
+ example="create_time-gt",
38
+ )
39
+ qv: Optional[Union[List[str], str]] = Field(
40
+ default=None,
41
+ title="Filter Value",
42
+ description="The value to filter by.",
43
+ example="2015-01-29",
44
+ )
45
+
46
+
47
+ class PaginationQueryParams(BaseModel):
48
+ """Used to paginate a the request results by limiting and offsetting."""
49
+
50
+ offset: Optional[int] = Field(
51
+ default=0,
52
+ ge=0,
53
+ title="Offset",
54
+ description="Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item",
55
+ )
56
+ limit: Optional[int] = Field(
57
+ default=None,
58
+ ge=1,
59
+ title="Limit",
60
+ description="The maximum number of items to return.",
61
+ )
62
+
63
+
64
+ class FilterQueryParams(ValueFilterQueryParams, PaginationQueryParams):
65
+ """Contains full filtering options to query elements, paginate and order them."""
66
+
67
+ order: Optional[str] = Field(
68
+ default=None,
69
+ title="Order",
70
+ description=(
71
+ "String containing one of the valid ordering attributes followed (optionally) "
72
+ "by '-asc' or '-dsc' for ascending and descending order respectively. "
73
+ "Orders can be stacked as a comma-separated list of values."
74
+ ),
75
+ example="name-dsc,create_time",
76
+ )
77
+
78
+
79
+ class SerializationParams(BaseModel):
80
+ """Contains common parameters for customizing model serialization."""
81
+
82
+ view: Optional[str] = Field(
83
+ default=None,
84
+ title="View",
85
+ description=(
86
+ "The name of the view used to serialize this item. "
87
+ "This will return a predefined set of attributes of the item."
88
+ ),
89
+ example="summary",
90
+ )
91
+ keys: Optional[List[str]] = Field(
92
+ default=None,
93
+ title="Keys",
94
+ description=(
95
+ "List of keys (name of the attributes) that will be returned in addition "
96
+ "to the ones included in the `view`."
97
+ ),
98
+ )
99
+ default_view: Optional[str] = Field(
100
+ default=None,
101
+ title="Default View",
102
+ description="The item view that will be used in case none was specified.",
103
+ )
104
+
105
+
106
+ class PdfDocumentType(str, Enum):
107
+ invocation_report = "invocation_report"
108
+ page = "page"
109
+
110
+
111
+ class APIKeyModel(BaseModel):
112
+ key: str = Field(Required, title="Key", description="API key to interact with the Galaxy API")
113
+ create_time: datetime = Field(
114
+ Required, title="Create Time", description="The time and date this API key was created."
115
+ )
@@ -0,0 +1,97 @@
1
+ from typing import List
2
+
3
+ from pydantic import BaseModel
4
+ from typing_extensions import Literal
5
+
6
+ from .description_domain import (
7
+ DescriptionDomain,
8
+ PipelineStep,
9
+ Uri as DescriptionDomainUri,
10
+ XrefItem,
11
+ )
12
+ from .error_domain import ErrorDomain
13
+ from .execution_domain import (
14
+ ExecutionDomain,
15
+ ExternalDataEndpoint,
16
+ ScriptItem,
17
+ SoftwarePrerequisite,
18
+ Uri as ExecutionDomainUri,
19
+ )
20
+ from .io_domain import (
21
+ InputAndOutputDomain,
22
+ InputSubdomainItem,
23
+ OutputSubdomainItem,
24
+ Uri as InputAndOutputDomainUri,
25
+ )
26
+ from .parametric_domain import (
27
+ ParametricDomain,
28
+ ParametricDomainItem,
29
+ )
30
+ from .provenance_domain import (
31
+ ContributionEnum,
32
+ Contributor,
33
+ ProvenanceDomain,
34
+ )
35
+ from .usability_domain import UsabilityDomain
36
+
37
+ SPEC_VERSION = "https://w3id.org/ieee/ieee-2791-schema/2791object.json"
38
+
39
+
40
+ class GalaxyExtension(BaseModel):
41
+ galaxy_url: str
42
+ galaxy_version: str
43
+
44
+
45
+ class GalaxyExtensionDomain(BaseModel):
46
+ extension_schema: Literal[
47
+ "https://raw.githubusercontent.com/biocompute-objects/extension_domain/1.2.0/galaxy/galaxy_extension.json"
48
+ ] = "https://raw.githubusercontent.com/biocompute-objects/extension_domain/1.2.0/galaxy/galaxy_extension.json"
49
+ galaxy_extension: GalaxyExtension
50
+
51
+
52
+ class BioComputeObjectCore(BaseModel):
53
+ """BioComputeObject pre-hash, used to generate etag."""
54
+
55
+ description_domain: DescriptionDomain
56
+ error_domain: ErrorDomain
57
+ execution_domain: ExecutionDomain
58
+ extension_domain: List[GalaxyExtensionDomain]
59
+ io_domain: InputAndOutputDomain
60
+ parametric_domain: ParametricDomain
61
+ provenance_domain: ProvenanceDomain
62
+ usability_domain: UsabilityDomain
63
+
64
+
65
+ class BioComputeObject(BioComputeObjectCore):
66
+ object_id: str
67
+ spec_version: str = SPEC_VERSION
68
+ etag: str
69
+
70
+
71
+ __all__ = (
72
+ "BioComputeObjectCore",
73
+ "BioComputeObject",
74
+ "Contributor",
75
+ "ContributionEnum",
76
+ "DescriptionDomain",
77
+ "DescriptionDomainUri",
78
+ "ErrorDomain",
79
+ "ExecutionDomain",
80
+ "ExecutionDomainUri",
81
+ "ExternalDataEndpoint",
82
+ "GalaxyExtension",
83
+ "GalaxyExtensionDomain",
84
+ "InputAndOutputDomain",
85
+ "InputSubdomainItem",
86
+ "OutputSubdomainItem",
87
+ "InputAndOutputDomainUri",
88
+ "ParametricDomain",
89
+ "ParametricDomainItem",
90
+ "PipelineStep",
91
+ "ProvenanceDomain",
92
+ "ScriptItem",
93
+ "SoftwarePrerequisite",
94
+ "SPEC_VERSION",
95
+ "UsabilityDomain",
96
+ "XrefItem",
97
+ )
@@ -0,0 +1,133 @@
1
+ # generated by datamodel-codegen:
2
+ # filename: https://opensource.ieee.org/2791-object/ieee-2791-schema/-/raw/master/description_domain.json
3
+ # timestamp: 2022-09-13T23:51:48+00:00
4
+
5
+ from __future__ import annotations
6
+
7
+ from datetime import datetime
8
+ from enum import Enum
9
+ from typing import (
10
+ List,
11
+ Optional,
12
+ )
13
+
14
+ from pydantic import (
15
+ AnyUrl,
16
+ BaseModel,
17
+ EmailStr,
18
+ Extra,
19
+ Field,
20
+ )
21
+
22
+
23
+ class XrefItem(BaseModel):
24
+ namespace: str = Field(..., description="External resource vendor prefix", example=["pubchem.compound"])
25
+ name: str = Field(..., description="Name of external reference", example=["PubChem-compound"])
26
+ ids: List[str] = Field(..., description="List of reference identifiers")
27
+ access_time: datetime = Field(..., description="Date and time the external reference was accessed")
28
+
29
+
30
+ class Uri(BaseModel):
31
+ class Config:
32
+ extra = Extra.forbid
33
+
34
+ filename: Optional[str] = None
35
+ uri: AnyUrl
36
+ access_time: Optional[datetime] = Field(
37
+ None, description="Time stamp of when the request for this data was submitted"
38
+ )
39
+ sha1_checksum: Optional[str] = Field(
40
+ None, description="output of hash function that produces a message digest", regex="[A-Za-z0-9]+"
41
+ )
42
+
43
+
44
+ class ObjectId(BaseModel):
45
+ __root__: str = Field(
46
+ ...,
47
+ description="A unique identifier that should be applied to each IEEE-2791 Object instance, generated and assigned by a IEEE-2791 database engine. IDs should never be reused",
48
+ )
49
+
50
+
51
+ class ContributionEnum(Enum):
52
+ authoredBy = "authoredBy"
53
+ contributedBy = "contributedBy"
54
+ createdAt = "createdAt"
55
+ createdBy = "createdBy"
56
+ createdWith = "createdWith"
57
+ curatedBy = "curatedBy"
58
+ derivedFrom = "derivedFrom"
59
+ importedBy = "importedBy"
60
+ importedFrom = "importedFrom"
61
+ providedBy = "providedBy"
62
+ retrievedBy = "retrievedBy"
63
+ retrievedFrom = "retrievedFrom"
64
+ sourceAccessedBy = "sourceAccessedBy"
65
+
66
+
67
+ class Contributor(BaseModel):
68
+ class Config:
69
+ extra = Extra.forbid
70
+
71
+ name: str = Field(..., description="Name of contributor", example=["Charles Darwin"])
72
+ affiliation: Optional[str] = Field(
73
+ None, description="Organization the particular contributor is affiliated with", example=["HMS Beagle"]
74
+ )
75
+ email: Optional[EmailStr] = Field(
76
+ None,
77
+ description="electronic means for identification and communication purposes",
78
+ example=["name@example.edu"],
79
+ )
80
+ contribution: List[ContributionEnum] = Field(
81
+ ..., description="type of contribution determined according to PAV ontology"
82
+ )
83
+ orcid: Optional[AnyUrl] = Field(
84
+ None,
85
+ description="Field to record author information. ORCID identifiers allow for the author to curate their information after submission. ORCID identifiers must be valid and must have the prefix ‘https://orcid.org/’",
86
+ example=["http://orcid.org/0000-0002-1825-0097"],
87
+ )
88
+
89
+
90
+ class PrerequisiteItem(BaseModel):
91
+ name: str = Field(
92
+ ..., description="Public searchable name for reference or prereq.", example=["Hepatitis C virus genotype 1"]
93
+ )
94
+ uri: Uri
95
+
96
+
97
+ class PipelineStep(BaseModel):
98
+ class Config:
99
+ extra = Extra.forbid
100
+
101
+ step_number: int = Field(
102
+ ...,
103
+ description="Non-negative integer value representing the position of the tool in a one-dimensional representation of the pipeline.",
104
+ )
105
+ name: str = Field(..., description="This is a recognized name of the software tool", example=["HIVE-hexagon"])
106
+ description: str = Field(
107
+ ..., description="Specific purpose of the tool.", example=["Alignment of reads to a set of references"]
108
+ )
109
+ version: Optional[str] = Field(
110
+ None,
111
+ description="Version assigned to the instance of the tool used corresponding to the upstream release.",
112
+ example=["1.3"],
113
+ )
114
+ prerequisite: Optional[List[PrerequisiteItem]] = Field(None, description="Reference or required prereqs")
115
+ input_list: List[Uri] = Field(..., description="URIs (expressed as a URN or URL) of the input files for each tool.")
116
+ output_list: List[Uri] = Field(
117
+ ..., description="URIs (expressed as a URN or URL) of the output files for each tool."
118
+ )
119
+
120
+
121
+ class DescriptionDomain(BaseModel):
122
+ keywords: List[str] = Field(..., description="Keywords to aid in search-ability and description of the object.")
123
+ xref: Optional[List[XrefItem]] = Field(
124
+ None, description="List of the databases or ontology IDs that are cross-referenced in the IEEE-2791 Object."
125
+ )
126
+ platform: Optional[List[str]] = Field(
127
+ None,
128
+ description="reference to a particular deployment of an existing platform where this IEEE-2791 Object can be reproduced.",
129
+ )
130
+ pipeline_steps: List[PipelineStep] = Field(
131
+ ...,
132
+ description="Each individual tool (or a well defined and reusable script) is represented as a step. Parallel processes are given the same step number.",
133
+ )