|
| 1 | +Metadata-Version: 2.1 |
| 2 | +Name: opensafely-pipeline |
| 3 | +Version: 2025.3.6.161237 |
| 4 | +Summary: OpenSAFELY pipeline configuration parsing library |
| 5 | +Author-email: OpenSAFELY < [email protected]> |
| 6 | +License: ${GITHUB_REPOSITORY_NAME} |
| 7 | + Copyright (C) University of Oxford |
| 8 | + |
| 9 | + This program is free software: you can redistribute it and/or modify |
| 10 | + it under the terms of the GNU General Public License as published by |
| 11 | + the Free Software Foundation, either version 3 of the License, or |
| 12 | + (at your option) any later version. |
| 13 | + |
| 14 | + This program is distributed in the hope that it will be useful, |
| 15 | + but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | + GNU General Public License for more details. |
| 18 | + |
| 19 | + You should have received a copy of the GNU General Public License |
| 20 | + along with this program. If not, see <https://www.gnu.org/licenses/>. |
| 21 | + |
| 22 | +Project-URL: Home, https://opensafely.org |
| 23 | +Project-URL: Documentation, https://docs.opensafely.org |
| 24 | +Project-URL: Source, https://github.com/opensafely-core/pipeline |
| 25 | +Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+) |
| 26 | +Requires-Python: >=3.8 |
| 27 | +Description-Content-Type: text/markdown |
| 28 | +License-File: LICENSE |
| 29 | +Requires-Dist: ruyaml |
| 30 | +Provides-Extra: fastparser |
| 31 | +Requires-Dist: ruamel-yaml==0.18.6; extra == "fastparser" |
| 32 | +Requires-Dist: ruamel-yaml-clib==0.2.8; extra == "fastparser" |
| 33 | + |
| 34 | +# OpenSAFELY Pipeline Parser |
| 35 | + |
| 36 | +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. |
| 37 | + |
| 38 | +For example: |
| 39 | + |
| 40 | + with open("/path/to/project.yaml") as f: |
| 41 | + data = load_pipeline(f.read()) |
| 42 | + |
| 43 | + |
| 44 | +The returned object is an instance of `pipeline.models.Pipeline`. |
| 45 | + |
| 46 | + |
| 47 | +## Developer docs |
| 48 | + |
| 49 | +Please see the [additional information](DEVELOPERS.md). |
0 commit comments