python-validator

https://github.com/bids-standard/python-validator

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 3 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (12.6%) to scientific vocabulary

Last synced: 6 months ago · JSON representation

Repository

Basic Info

Host: GitHub
Owner: bids-standard
License: mit
Language: Python
Default Branch: main
Size: 701 KB

Statistics

Stars: 5
Watchers: 12
Forks: 3
Open Issues: 11
Releases: 0

Created almost 2 years ago · Last pushed 6 months ago

Metadata Files

Readme License Zenodo

Python BIDS-Validator

This is a library of helper functions written in Python, for use with BIDS compliant applications written in this language.

The main function determines if a file path is compliant with the BIDS specification.

Installation

To install with pip:

python -m pip install bids_validator

To install with conda:

conda install bids-validator

Quickstart

Open a Python terminal and type: python
Import the BIDS Validator package from bids_validator import BIDSValidator
Check if a file is BIDS compatible BIDSValidator().is_bids('/relative/path/to/a/bids/file')
Note, the file path must be relative to the root of the BIDS dataset, and a leading forward slash / must be added to the file path.

Example

```Python from bids_validator import BIDSValidator

validator = BIDSValidator()

filepaths = ["/sub-01/anat/sub-01rec-CSDT1w.nii.gz", "/sub-01/anat/sub-01acq-23rec-CSDT1w.exe"] for filepath in filepaths: print(validator.isbids(filepath)) # will print True, and then False ```

Note, the file path must be relative to the root of the BIDS dataset, and a leading forward slash / must be added to the file path.

Acknowledgments

Many contributions to the bids-validator were done by members of the BIDS community. See the list of contributors.

A large part of the initial development of bids-validator was done by Squishymedia, who are in turn financed through different grants offered for the general development of BIDS. See the list below.

Development and contributions were supported through the following federally funded projects/grants:

Maintainers and Contributors

This project follows the all-contributors specification. Contributions of any kind are welcome!

The project is maintained by @rwblair with the help of many contributors listed below. (The emoji key is indicating the kind of contribution)

Please also see Acknowledgments.

_{Adam Li} 💻 ⚠️ 📓 🐛	_{Adam Thomas} 📖	_{Alexander Jones} 💻 ⚠️ 🤔	_{Ben Beasley} 📦	_{Chris Gorgolewski} 🐛 💻 🔣 📖 💡 🤔 🚇 🚧 🧑‍🏫 💬 👀 ⚠️ ✅ 📢 📓	_{Chris Holdgraf} 💻	_{Chris Markiewicz} 💻 ⚠️ 🤔 🐛 💬 🔧 🚧
_{David Nishikawa} 💻 ⚠️	_{Dimitri Papadopoulos Orfanos} 💻	_{Duncan Macleod} 🚇	_{Franklin Feingold} 📖	_{Gregory noack} 💻 ⚠️	_{Horea Christian} 💻	_{Jakub Kaczmarzyk} 🚇
_{Joke Durnez} 💻	_{Mainak Jas} 💻 ⚠️ 🤔 👀 📓	_{Marco Castellaro} 💻 ⚠️	_Max 💻 🐛	_{Michael Hanke} 📖	_{Mikael Naveau} 💻	_{Nell Hardcastle} 💻 🤔 🚇 💬 👀
_{Nicolas Traut} 💻	_{Parul Sethi} 💻 ⚠️	_{Patricia Clement} 💻	_{Remi Gau} 💻 📖 📓	_{Richard Höchenberger} 💻 📓 ⚠️ 🐛	_{Robert Oostenveld} 💻 🤔 🐛 ⚠️	_{Rohan Goyal} 💻
_{Ross Blair} 🚧 🤔 💻 🐛 🚇 📆 💬 👀 🔧 ⚠️	_{Russ Poldrack} 💻 💵 🔍	_{Soichi Hayashi} 🐛	_{Stefan Appelhoff} 🐛 💻 🔣 📖 💡 🤔 🚇 🚧 🧑‍🏫 💬 👀 ⚠️ ✅ 📢 📓	_Suyash 💻	_{Taylor Salo} 💻	_{Teal Hobson-Lowther} 💻 ⚠️
_{Travis Riddle} 🐛	_VisLab 🤔 💻	_{Wazeer Zulfikar} 📖	_{Yaroslav Halchenko} 🤔 💻 📖 📓	_constellates 💻 ⚠️	_dewarrn1 💻	_dkp 💻
_goldmund 💻 ⚠️