Metadata-Version: 2.1
Name: bids2openminds
Version: 0.1.0
Summary: Generates openMINDS metadata from a BIDS dataset
Author-email: Peyman Najafi <peyman.najafi@cnrs.fr>, "Andrew P. Davison" <andrew.davison@cnrs.fr>, Lyuba Zehl <lyuba.zehl@ebrains.eu>
License: MIT License
        
        Copyright (c) 2023 openMetadataInitiative
        
        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.
        
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: bids
Requires-Dist: openminds >=0.2.3
Requires-Dist: click >=8.1
Requires-Dist: pandas
Requires-Dist: nameparser >=1.1.3
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'

# bids2openminds
A tool to generate openMINDS metadata from BIDS datasets

In active development, please try the first alpha release and send us feedback by creating an issue.  

## Installation

```
pip install bids2openminds
```

## Usage

```
Usage: bids2openminds [OPTIONS] INPUT_PATH

Options:
  -o, --output-path PATH          The output path or filename for OpenMINDS
                                  file/files.
  --single-file                   Save the entire collection into a single
                                  file (default).
  --multiple-files                Each node is saved into a separate file
                                  within the specified directory. 'output-
                                  path' if specified, must be a directory.
  -e, --include-empty-properties  Whether to include empty properties in the
                                  final file.
  -q, --quiet                     Not generate the final report and no
                                  warning.
  --help                          Show this message and exit.
```

## For developers

To run tests:
```
  $ pytest
```
