Metadata-Version: 2.1
Name: bids2cite
Version: 0.1.1
Summary: create a citation file for a BIDS dataset
Home-page: https://github.com/Remi-Gau/bids2cite
Download-URL: https://github.com/Remi-Gau/bids2cite
Author: Remi Gau
Maintainer: Remi Gau
Maintainer-email: remi.gau@gmail.com
License: LGPL-3.0
Keywords: BIDS,datacite
Platform: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Provides: bids2cite
Description-Content-Type: text/markdown; charset=UTF-8
License-File: LICENSE
Requires-Dist: rich
Requires-Dist: ruamel.yaml
Requires-Dist: black
Requires-Dist: requests
Requires-Dist: isort
Requires-Dist: crossref-commons
Requires-Dist: pandas
Provides-Extra: dev
Requires-Dist: sphinx (>=2.0) ; extra == 'dev'
Requires-Dist: sphinx-argparse ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
Requires-Dist: sphinx-copybutton ; extra == 'dev'
Requires-Dist: myst-parser ; extra == 'dev'
Requires-Dist: rstcheck ; extra == 'dev'
Requires-Dist: flake8 (>=3.7) ; extra == 'dev'
Requires-Dist: flake8-docstrings (>=1.5) ; extra == 'dev'
Requires-Dist: black (>=21) ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: sourcery ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: types-requests ; extra == 'dev'
Requires-Dist: pytest (>=6.2.5) ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: coverage ; extra == 'dev'
Provides-Extra: doc
Requires-Dist: sphinx (>=2.0) ; extra == 'doc'
Requires-Dist: sphinx-argparse ; extra == 'doc'
Requires-Dist: sphinx-rtd-theme ; extra == 'doc'
Requires-Dist: sphinx-copybutton ; extra == 'doc'
Requires-Dist: myst-parser ; extra == 'doc'
Requires-Dist: rstcheck ; extra == 'doc'
Provides-Extra: docs
Requires-Dist: sphinx (>=2.0) ; extra == 'docs'
Requires-Dist: sphinx-argparse ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: sphinx-copybutton ; extra == 'docs'
Requires-Dist: myst-parser ; extra == 'docs'
Requires-Dist: rstcheck ; extra == 'docs'
Provides-Extra: style
Requires-Dist: flake8 (>=3.7) ; extra == 'style'
Requires-Dist: flake8-docstrings (>=1.5) ; extra == 'style'
Requires-Dist: black (>=21) ; extra == 'style'
Requires-Dist: pre-commit ; extra == 'style'
Requires-Dist: sourcery ; extra == 'style'
Requires-Dist: mypy ; extra == 'style'
Requires-Dist: types-requests ; extra == 'style'
Provides-Extra: test
Requires-Dist: pytest (>=6.2.5) ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: coverage ; extra == 'test'
Provides-Extra: tests
Requires-Dist: pytest (>=6.2.5) ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'
Requires-Dist: coverage ; extra == 'tests'

[![codecov](https://codecov.io/gh/Remi-Gau/bids2cite/branch/main/graph/badge.svg?token=UBE490738A)](https://codecov.io/gh/Remi-Gau/bids2cite)
[![License](https://img.shields.io/badge/license-GPL3-blue.svg)](./LICENSE)
![https://github.com/psf/black](https://img.shields.io/badge/code%20style-black-000000.svg)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Remi-Gau/bids2cite/main.svg)](https://results.pre-commit.ci/latest/github/Remi-Gau/bids2cite/main)

# bids2cite

Create a citation file for a BIDS dataset.

Can also be used to update references, authors and add license to a dataset.

## Installation

```bash
git clone https://github.com/Remi-Gau/bids2cite.git
cd bids2cite
pip install .
```

### For developers

```bash
pip install .[dev]
```

Basic tests can be run with:

```bash
make test
make test-cli
```

## Usage

The most basic usage is:

```bash
bids2cite path_to_bids_dataset
```

An example of call with all the options:

```bash
bids2cite "tests/bids" \
    --keywords "foo, bar, me" \
    --description "this is the description of my dataset" \
    --authors_file "inputs/authors.tsv" \
    --skip-prompt false \
    --verbosity INFO
```

`--keywords` and `--description` allow you to pass keywords and description to
add to the citation file.

`--skip-prompt` is set to `false` (default) to prompt you for information to add
to the citation file.

`--authors_file` points to a TSV file containing potential authors to add
citation file. This can be useful if you need to have a single file to keep
track of several lab members and only pick the relevant ones to add to a given
dataset.

This TSV file must at least have `first_name` and `last_name` columns, but can
also include `ORCID` and `affiliation` columns.

| first_name | last_name | ORCID               | affiliation |
| ---------- | --------- | ------------------- | ----------- |
| Rémi       | Gau       | 0000-0002-1535-9767 | UCLouvain   |
| Mohamed    | Rezk      | 0000-0002-1866-8645 | UCLouvain   |

There is a sample TSV in the [inputs folder](./inputs).

Type the following for more info on how to run it:

```bash
bids2cite --help
```
