cnb-tools

Convenience tools/functions for challenges and benchmarking on Synapse.org

📖 Documentation: https://sage-bionetworks-challenges.github.io/cnb-tools

👾 Source code: https://github.com/Sage-Bionetworks-Challenges/cnb-tools

cnb-tools is a set of tools and commands that provides an interface for managing crowd-sourced challenges hosted on Synapse.org, including but not limited to, DREAM Challenges.

Requirements

To fully utilize cnb-tools, you must have a Synapse account and provide your credentials to the tool. First, generate a Synapse Personal Access Token (PAT) with all token permissions enabled.

Next, run the following command, then follow the prompts to enter your Synapse username and PAT:

synapse config

This will create a .synapseConfig file in your home directory. For security, we recommend updating its permissions so that other users on your machine do not have read access to your credentials, e.g.

chmod 600 ~/.synapseConfig

Installation

For best practice, use a Python environment to install cnb-tools rather than directly into your base env. In our docs, we will be using uv, but you can use venv, pyenv, etc.

# Create a new env and activate it
uv venv --python 3.12 .venv
source .venv/bin/activate

# Install cnb-tools
uv pip install cnb-tools

ⓘ NOTE

cnb-tools builds off of the Synapse Python Client — by installing cnb-tools, you will also be installing synapseclient.

→ Read its docs.

Verify the installation with:

cnb-tools

Running With Docker

If you rather not install cnb-tools onto your machine, you may still use it via Docker! The package and list of versions are available here.

To provide your Synapse credentials to the Docker container, you must first create a file with your Synapse PAT as the SYNAPSE_AUTH_TOKEN environment variable:

SYNAPSE_AUTH_TOKEN=<YOUR PAT>

The docker run command will look something like this, assuming the file is named ~/.synapse-config:

docker run --rm \
  --env-file ~/.synapse-config \
  ghcr.io/sage-bionetworks-challenges/cnb-tools \
  COMMAND [ARGS]

License

cnb-tools is released under the Apache 2.0 license.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cnb_tools-0.6.0.tar.gz (226.0 kB view details)

Uploaded Jul 24, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

cnb_tools-0.6.0-py3-none-any.whl (36.4 kB view details)

Uploaded Jul 24, 2026 Python 3

File details

Details for the file cnb_tools-0.6.0.tar.gz.

File metadata

Download URL: cnb_tools-0.6.0.tar.gz
Upload date: Jul 24, 2026
Size: 226.0 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cnb_tools-0.6.0.tar.gz
Algorithm	Hash digest
SHA256	`84470d75b7cd5d5bf12bf4547e202a2d9fe9ea70eb7bdccd999accc43d140549`
MD5	`76c49c327d6459257f7e4b0c9ce44031`
BLAKE2b-256	`340a295c7dad7c7af9e0202b5beca2ec023b17315212ebe8dd484a2badc745c1`

See more details on using hashes here.

Provenance

The following attestation bundles were made for cnb_tools-0.6.0.tar.gz:

Publisher: publish.yml on Sage-Bionetworks-Challenges/cnb-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: cnb_tools-0.6.0.tar.gz
- Subject digest: 84470d75b7cd5d5bf12bf4547e202a2d9fe9ea70eb7bdccd999accc43d140549
- Sigstore transparency entry: 2239903356
- Sigstore integration time: Jul 24, 2026
Source repository:
- Permalink: Sage-Bionetworks-Challenges/cnb-tools@b063dc7c8541837bfeadcc0f6278ec4218b9c09f
- Branch / Tag: refs/tags/v0.6.0
- Owner: https://github.com/Sage-Bionetworks-Challenges
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@b063dc7c8541837bfeadcc0f6278ec4218b9c09f
- Trigger Event: release