Skip to content

Commit

Permalink
Updating toml (openMetadataInitiative#65)
Browse files Browse the repository at this point in the history
* toml

* updating readme

* typo

* readme
  • Loading branch information
Peyman-N authored Jun 21, 2024
1 parent c5f7be7 commit 50a051e
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 4 deletions.
4 changes: 4 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Peyman Najafi
Andrew P. Davison
Lyuba Zehl
Sophia Pieschnik
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,37 @@
# bids2openminds
A tool to generate openMINDS metadata from BIDS datasets

In active development, not yet released. More information coming soon!
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
```
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[project]
name = "bids2openminds"
version = "0.0.0"
version = "0.1.0"
dependencies = [
"bids",
"openminds >= 0.2.2",
"openminds >= 0.2.3",
"click>=8.1",
"pandas",
"nameparser >= 1.1.3"
Expand All @@ -12,6 +12,7 @@ requires-python = ">=3.9"
authors = [
{name = "Peyman Najafi", email = "[email protected]"},
{name = "Andrew P. Davison", email = "[email protected]"},
{name = "Lyuba Zehl", email = "[email protected]"}
]
description = "Generates openMINDS metadata from a BIDS dataset"
readme = "README.md"
Expand Down

0 comments on commit 50a051e

Please sign in to comment.