Skip to content

Sage-Bionetworks/challengeutils

Repository files navigation

Sage Bionetworks Challenge Utilities

Warning

Starting early 2024, this package will no longer be maintained. We are in the process of creating a new-and-improved version of challengeutils - more information coming soon!

Get challengeutils from PyPI Docker Automated Docker Pull Coverage Status

challengeutils is a set of tools and commands that provides an interface for managing crowd-sourced challenges administered on Synapse, including but not limited to, DREAM Challenges. Its main purpose is to ease the process of creating, monitoring, and ending a challenge, as well as provide useful functions for post-competition analysis. This package is being actively developed and maintained by DREAM and Informatics & Biocomputing (IBC), Computational Oncology Group at Sage Bionetworks.

Documentation

challengeutils functionality is documented, click here to check it out!

Installation

pip install challengeutils
challengeutils -v

This repository also uses pre-commit to autolint files according to Black's coding styles. To run the hook in your local dev environment, enter the following:

pip install pre-commit
pre-commit install

Now pre-commit will run automatically on git commit! For example:

$ git commit -m 'update readme' -a
Check Yaml...........................................(no files to check)Skipped
Fix End of Files.........................................................Passed
Trim Trailing Whitespace.................................................Passed
black................................................(no files to check)Skipped
[add-pre-commit 75b4393] update readme
 1 file changed, 23 insertions(+)

Contributing

Thinking about contributing to challengeutils? Get started by reading our Contributor Guide.