Skip to main content

Neurobagel CLI

Main branch checks status Tests status Codecov Python versions static License PyPI - Version PyPI - Downloads Docker Image Version (tag) Docker Pulls

The Neurobagel CLI is a Python command-line tool to automatically parse and describe subject phenotypic and imaging attributes in an annotated dataset for integration into the Neurobagel graph.

For information on how to use the CLI, please refer to the official Neurobagel documentation.

Installation

The Neurobagel CLI is available as a Python package that can be installed from PyPI using:

pip install bagel

(If you prefer to run the CLI using Docker or Singularity containers instead, please refer to the Neurobagel documentation.)

Development environment

Setting up a local development environment

To work on the CLI, we suggest that you create a development environment that is as close as possible to the environment we run in production. We use uv to set up local development environments.

  1. Clone the repository

    git clone https://github.com/neurobagel/bagel-cli.git
    cd bagel-cli
    
  2. Install the CLI and all development dependencies in editable mode with uv:

    uv sync --group dev
    
  3. Install the bids-examples and neurobagel_examples submodules needed to run the test suite:

    git submodule init
    git submodule update
    

Confirm that everything works well by running the tests: uv run pytest .

To run the CLI during local development, use:

uv run bagel

pre-commit is configured in the development environment for this repository, and can be set up to automatically run a number of code linters and formatters on any commit you make according to the consistent code style set for this project.

Run the following from the repository root to install the configured pre-commit "hooks" for your local clone of the repo:

uv run pre-commit install

pre-commit will now run automatically whenever you run git commit.

Updating dependencies

If new runtime or development dependencies are needed, add them with uv add. To change the version constraints of existing dependencies, edit pyproject.toml and then update the lockfile using uv lock.

Regenerating the Neurobagel vocabulary file

Terms in the Neurobagel namespace (nb prefix) and their class relationships are serialized to a file called nb_vocab.ttl, which is automatically uploaded to new Neurobagel graph deployments. This vocabulary is used by Neurobagel APIs to fetch available attributes and attribute instances from a graph store.

When the Neurobagel graph data model is updated (e.g., if new classes or subclasses are created), this file should be regenerated by running:

uv run python helper_scripts/generate_nb_vocab_file.py

This will create a file called nb_vocab.ttl in the current working directory.

Metadata

Release files for bagel 0.11.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for bagel 0.11.7
File Size Uploaded Provenance Actions
bagel-0.11.7.tar.gz 454.8 kB Without provenance Details for bagel-0.11.7.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for bagel 0.11.7
File Interpreter ABI Platform Actions
bagel-0.11.7-py3-none-any.whl Python 3 none any Details for bagel-0.11.7-py3-none-any.whl

Total release size: 812.5 kB

Release files / bagel-0.11.7.tar.gz

Download URL bagel-0.11.7.tar.gz
Size 454.8 kB
Tags Source
SHA-256 checksum
How to use checksums
4a012475c3f9d6d933d85b5e45990314974067693e91b9694f083b06aae3b190
BLAKE2b-256 checksum
How to use checksums
4489a9d2ecb9825eb38059c1732ca01f3f0cb20218469836516713aef01b72c2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / bagel-0.11.7-py3-none-any.whl

Download URL bagel-0.11.7-py3-none-any.whl
Size 357.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e27be0d712a3184fac3566d92f4ec1a3f004f01dbeede8ccab5b69468e3dd960
BLAKE2b-256 checksum
How to use checksums
498b0f14b09828fd03d5d83890df2628262d0b3b27438918e3e0f3f8d80240cb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Security for bagel 0.11.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page