Skip to main content

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

Project description

cnb-tools

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


PyPI version Supported Python versions License

📖 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. To do so, create a .synapseConfig file in your home directory and enter the following:

[authentication]
authtoken=<YOUR PAT>

Generate a new Synapse Personal Access Token (PAT) with all token permissions enabled, then copy-paste it into authtoken. Save the file.

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 miniconda, but you can use miniforge, venv, pyenv, etc.

# Create a new env and activate it
conda create -n cnb-tools python=3.12 -y
conda activate cnb-tools

# Install cnb-tools using pip
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.

Project details


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.3.2.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

cnb_tools-0.3.2-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cnb_tools-0.3.2.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.0 Darwin/22.6.0

File hashes

Hashes for cnb_tools-0.3.2.tar.gz
Algorithm Hash digest
SHA256 a4bbfe1f55b9a692a696d285d08869ada39fd748c5dc41725d5f2e0e84c7fa2e
MD5 75f6a79470a7e3803965283ea798388f
BLAKE2b-256 7bc1f961a19e81c56bc18f7eedddf51764d5cb96cb2670891455a2fec6badb7e

See more details on using hashes here.

File details

Details for the file cnb_tools-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: cnb_tools-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 15.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.0 Darwin/22.6.0

File hashes

Hashes for cnb_tools-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b9474034cead2871e1ed4f1ace437bd645418f71c220e21517a13c1db4dc73c7
MD5 c84b809ac2c505edef05df330b787499
BLAKE2b-256 e86c50bedccac78741cc7a7ba73c21ca8d66168c670708d3c824991d82486435

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page