Pipeline Validator
Install
You can install the file by using pip install bbp-atlas-pipeline-validator
Examples
You can use the validator in the following way:
from pipeline_validator.pipeline_validator import pipeline_validator
path_to_file = "./my_config.json"
token = "THIS_IS_MY_NEXUS_TOKEN"
whitelisted_vars = ["var1", "var2"]
pipeline_validator(path_to_file, token, whitelisted_vars)
where:
path_to_fileis the relative path to the configurationtokenis a valid nexus tokenwhitelisted_varsis an array of accepted variables
Configuration Format
The JSON configuration file should be in the following format:
{
"rules":[
{
"rule": "<NAME_OF_RULE_1>",
"execute":
[
{
"brainRegion": "http://api.brain-map.org/api/v2/data/Structure/<BRAIN_REGION_ID_1>",
"container": "docker://<PATH_TO_DOCKER_IMAGE>",
"command": "<THE COMMAND TO BE EXECUTED>"
},
{
"brainRegion": "http://api.brain-map.org/api/v2/data/Structure/<BRAIN_REGION_ID_2>",
"container": "docker://<PATH_TO_DOCKER_IMAGE>",
"command": "<THE COMMAND TO BE EXECUTED>"
}
]
},
{
"rule": "<NAME_OF_RULE_2>",
"execute":
[
{
"brainRegion": "http://api.brain-map.org/api/v2/data/Structure/<BRAIN_REGION_ID_1>",
"container": "docker://<PATH_TO_DOCKER_IMAGE>",
"command": "<THE COMMAND TO BE EXECUTED>"
},
{
"brainRegion": "http://api.brain-map.org/api/v2/data/Structure/<BRAIN_REGION_ID_2>",
"container": "docker://<PATH_TO_DOCKER_IMAGE>",
"command": "<THE COMMAND TO BE EXECUTED>"
}
]
}
]
}
Validation Criteria
The following criteria need to be met in order for the configuration to be validated:
- The configuration need to follow the above JSON schema
- Brain region ID should be valid (exist in brain region ontology)
- Within each rule, each brain region need to be followed by brain region that are not related or that they are descendants in the ontology
- For each command, the variables passed need to be part of the whitelisted variables
Funding & Acknowledgment
The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.
Copyright © 2023-2024 Blue Brain Project/EPFL
Metadata
Release files for bbp-atlas-pipeline-validator 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| bbp_atlas_pipeline_validator-0.4.0.tar.gz | 15.4 kB | Without provenance | Details for bbp_atlas_pipeline_validator-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| bbp_atlas_pipeline_validator-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for bbp_atlas_pipeline_validator-0.4.0-py3-none-any.whl |
Total release size: 32.5 kB
Release files / bbp_atlas_pipeline_validator-0.4.0.tar.gz
| Download URL | bbp_atlas_pipeline_validator-0.4.0.tar.gz |
|---|---|
| Size | 15.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6722dbe1d10f5b1cdd4b16e2901f439ef647fb89711315a17e9337903a721019
|
|
BLAKE2b-256 checksum How to use checksums |
dac2542dcee3428fc4dc91d2868b5cfcbe0180c31f1d117684bdea1653d4a50e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.20
|
Release files / bbp_atlas_pipeline_validator-0.4.0-py3-none-any.whl
| Download URL | bbp_atlas_pipeline_validator-0.4.0-py3-none-any.whl |
|---|---|
| Size | 17.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b536004a199c3d6752681d0b2eba01e37d4e80cf4b5fc3acb1081af57e29bd3c
|
|
BLAKE2b-256 checksum How to use checksums |
9a6777aed96ffb73071cb91d461ed78c40e5cecc29a71a6b22a776da1b6beec0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.20
|
Security for bbp-atlas-pipeline-validator 0.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.