generated from opensafely-core/repo-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4bda291
commit 2c36edf
Showing
6 changed files
with
88 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
Metadata-Version: 2.1 | ||
Name: opensafely-pipeline | ||
Version: 2024.10.11.170331 | ||
Summary: OpenSAFELY pipeline configuration parsing library | ||
Author-email: OpenSAFELY <[email protected]> | ||
License: ${GITHUB_REPOSITORY_NAME} | ||
Copyright (C) University of Oxford | ||
|
||
This program is free software: you can redistribute it and/or modify | ||
it under the terms of the GNU General Public License as published by | ||
the Free Software Foundation, either version 3 of the License, or | ||
(at your option) any later version. | ||
|
||
This program is distributed in the hope that it will be useful, | ||
but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
GNU General Public License for more details. | ||
|
||
You should have received a copy of the GNU General Public License | ||
along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
|
||
Project-URL: Home, https://opensafely.org | ||
Project-URL: Documentation, https://docs.opensafely.org | ||
Project-URL: Source, https://github.com/opensafely-core/pipeline | ||
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+) | ||
Requires-Python: >=3.8 | ||
Description-Content-Type: text/markdown | ||
License-File: LICENSE | ||
Requires-Dist: ruyaml | ||
Provides-Extra: fastparser | ||
Requires-Dist: ruamel-yaml==0.18.6; extra == "fastparser" | ||
Requires-Dist: ruamel-yaml-clib==0.2.8; extra == "fastparser" | ||
|
||
# OpenSAFELY Pipeline Parser | ||
|
||
This library takes the contents of an OpenSAFELY pipeline configuration file (`project.yaml` or `pipeline.yaml`), validates it, and parses it into a typed structure. | ||
|
||
For example: | ||
|
||
with open("/path/to/project.yaml") as f: | ||
data = load_pipeline(f.read()) | ||
|
||
|
||
The returned object is an instance of `pipeline.models.Pipeline`. | ||
|
||
|
||
## Developer docs | ||
|
||
Please see the [additional information](DEVELOPERS.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
LICENSE | ||
README.md | ||
pyproject.toml | ||
version | ||
fastparser/requirements.txt | ||
opensafely_pipeline.egg-info/PKG-INFO | ||
opensafely_pipeline.egg-info/SOURCES.txt | ||
opensafely_pipeline.egg-info/dependency_links.txt | ||
opensafely_pipeline.egg-info/requires.txt | ||
opensafely_pipeline.egg-info/top_level.txt | ||
pipeline/__init__.py | ||
pipeline/__main__.py | ||
pipeline/constants.py | ||
pipeline/exceptions.py | ||
pipeline/features.py | ||
pipeline/legacy.py | ||
pipeline/loading.py | ||
pipeline/main.py | ||
pipeline/models.py | ||
pipeline/outputs.py | ||
pipeline/validation.py | ||
tests/test_fastparser.py | ||
tests/test_features.py | ||
tests/test_legacy.py | ||
tests/test_loading.py | ||
tests/test_main.py | ||
tests/test_models.py | ||
tests/test_outputs.py | ||
tests/test_type_validation.py | ||
tests/test_validation.py |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
ruyaml | ||
|
||
[fastparser] | ||
ruamel-yaml==0.18.6 | ||
ruamel-yaml-clib==0.2.8 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
pipeline |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters