bids-validator-deno 2.2.3__py2.py3-none-macosx_10_12_x86_64.whl

bids_validator_deno-2.2.3.dist-info/METADATA

@@ -0,0 +1,118 @@
+Metadata-Version: 2.1
+Name: bids-validator-deno
+Version: 2.2.3
+Summary: Typescript implementation of the BIDS validator
+Keywords: BIDS,BIDS validator
+Author: bids-standard developers
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: JavaScript
+Project-URL: Documentation, https://bids-validator.readthedocs.io/
+Project-URL: Source code, https://github.com/bids-standard/bids-validator
+Project-URL: Issues, https://github.com/bids-standard/bids-validator/issues
+Description-Content-Type: text/markdown
+
+[![Deno build](https://github.com/bids-standard/bids-validator/actions/workflows/deno_tests.yml/badge.svg)](https://github.com/bids-standard/bids-validator/actions/workflows/deno_tests.yml)
+[![Web validator](https://github.com/bids-standard/bids-validator/actions/workflows/web_build.yml/badge.svg)](https://github.com/bids-standard/bids-validator/actions/workflows/web_build.yml)
+[![Documentation Status](https://readthedocs.org/projects/bids-validator/badge/?version=latest)](https://bids-validator.readthedocs.io/en/latest/?badge=latest)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3688707.svg)](https://doi.org/10.5281/zenodo.3688707)
+
+# The BIDS Validator
+
+The BIDS Validator is a web application, command-line utility,
+and Javascript/Typescript library for assessing compliance with the
+[Brain Imaging Data Structure (BIDS)][BIDS] standard.
+
+## Getting Started
+
+In most cases,
+the simplest way to use the validator is to browse to the [BIDS Validator][] web page:
+
+![The web interface to the BIDS Validator with the "Select Dataset Files" button highlighted.
+(Dark theme)](docs/_static/web_entrypoint_dark.png#gh-dark-mode-only)
+![The web interface to the BIDS Validator with the "Select Dataset Files" button highlighted.
+(Light theme)](docs/_static/web_entrypoint_light.png#gh-light-mode-only)
+
+The web validator runs in-browser, and does not transfer data to any remote server.
+
+In some contexts, such as when working on a remote server,
+it may be easier to use the command-line.
+The BIDS Validator can be run with the [Deno][] runtime
+(see [Deno - Installation][] for detailed installation instructions):
+
+```shell
+deno run -ERWN jsr:@bids/validator
+```
+
+Deno by default sandboxes applications like a web browser.
+`-E`, `-R`, `-W`, and `-N` allow the validator to read environment variables,
+read/write local files, and read network locations.
+
+A pre-compiled binary is published to [PyPI][] and may be installed with:
+
+```
+pip install bids-validator-deno
+bids-validator-deno --help
+```
+
+### Configuration file
+
+The schema validator accepts a JSON configuration file that reclassifies issues as
+warnings, errors or ignored.
+
+```json
+{
+  "ignore": [
+    { "code": "JSON_KEY_RECOMMENDED", "location": "/T1w.json" }
+  ],
+  "warning": [],
+  "error": [
+    { "code": "NO_AUTHORS" }
+  ]
+}
+```
+
+The issues are partial matches of the `issues` that the validator accumulates.
+Pass the `--json` flag to see the issues in detail.
+
+### Development tools
+
+From the repository root, use `./local-run` to run with all permissions enabled by default:
+
+```shell
+# Run from within the /bids-validator directory
+cd bids-validator
+# Run validator:
+./local-run path/to/dataset
+```
+
+## Schema validator test suite
+
+```shell
+# Run tests:
+deno test --allow-env --allow-read --allow-write src/
+```
+
+This test suite includes running expected output from bids-examples and may throw some expected failures for bids-examples datasets where either the schema or validator are misaligned with the example dataset while under development.
+
+## Modifying and building a new schema
+
+To modify the schema a clone of bids-standard/bids-specification will need to be made. README and schema itself live here https://github.com/bids-standard/bids-specification/tree/master/src/schema.
+
+After changes to the schema have been made to a local copy the dereferenced single json file used by the validator will need to be built. The `bidsschematools` python package does this. It can be installed from pypi via pip or a local installation can be made. It lives in the specification repository here https://github.com/bids-standard/bids-specification/tree/master/tools/schemacode
+
+The command to compile a dereferenced schema is `bst -v export --schema src/schema --output src/schema.json` (this assumes you are in the root of the bids-specification repo). Once compiled it can be passed to the validator via the `-s` flag, `./bids-validator-deno -s <path to schema> <path to dataset>`
+
+
+## Documentation
+
+The BIDS validator documentation is available on [Read the Docs](https://bids-validator.readthedocs.io/en/latest/).
+
+[BIDS]: https://bids.neuroimaging.io
+[BIDS Validator]: https://bids-standard.github.io/bids-validator/
+[Deno]: https://deno.com/
+[Deno - Installation]: https://docs.deno.com/runtime/getting_started/installation/
+[PyPI]: https://pypi.org/project/bids-validator-deno/

bids_validator_deno-2.2.3.dist-info/RECORD

@@ -0,0 +1,6 @@
+bids_validator_deno-2.2.3.data/scripts/bids-validator-deno,sha256=YBDUin0I-uj47XcvrXmXH7m0Jq4fRLt1QjjPeYu6Zjo,142598608
+bids_validator_deno-2.2.3.dist-info/RECORD,,
+bids_validator_deno-2.2.3.dist-info/WHEEL,sha256=hUK_eJQZ3NYn4htwc0ams8EtErd-wXIt1Fz9VSOB2Hk,168
+bids_validator_deno-2.2.3.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+bids_validator_deno-2.2.3.dist-info/METADATA,sha256=mc8KVslGzGwUk1G3hZS5sflIr-HXuuPl8Xm_kvYWFeg,5084
+bids_validator_deno-2.2.3.dist-info/licenses/LICENSE,sha256=taiKo4hSfclPHHLO2tdj9Da-Fdgdxr4mj8Jy1rpOB1o,1128

bids_validator_deno-2.2.3.dist-info/WHEEL

@@ -0,0 +1,7 @@
+Wheel-Version: 1.0
+Generator: pdm-backend (2.4.6)
+Root-Is-Purelib: true
+Tag: py2-none-macosx_10_12_x86_64
+Tag: py3-none-macosx_10_12_x86_64
+Generator: delocate 0.13.0
+

bids_validator_deno-2.2.3.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+
+[gui_scripts]
+

bids_validator_deno-2.2.3.dist-info/licenses/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 The Board of Trustees of the Leland Stanford Junior University
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.