grand-challenge-forge 0.7.5
Generation of challenge packs
License: Apache-2.0
Requires Python: >3.10


# 🛠️ grand-challenge-forge

A utility that generates distributable items that help challenge organizers set up their challenge more easily on
[Grand-Challenge.org](https://grand-challenge.org/).

---
[![CI](https://github.com/DIAGNijmegen/rse-grand-challenge-forge/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/DIAGNijmegen/rse-grand-challenge-forge/actions/workflows/ci.yml/badge.svg?branch=main)
[![PyPI](https://img.shields.io/pypi/v/grand-challenge-forge)](https://pypi.org/project/grand-challenge-forge/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/grand-challenge-forge)](https://pypi.org/project/grand-challenge-forge/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

## Install

Install via PyPi:

```shell
pip install grand-challenge-forge
grand-challenge-forge --help
```

## 📦 Challenge packs

A challenge pack consists of challenge-tailored examples for the following:

* A script to _automate uploading_ data to an archive
* A _submission algorithm_ that can be submitted to a challenge phase
* An _evaluation method_ that evaluates algorithm submissions and generates performance
  metrics for ranking

## Usage

### PACK generation

```shell
grand-challenge-forge pack pack-context.json
```

Will use the context found in `pack-context.json` and generate a pack at the current working directory in
a directory `dist/` (default).

Alternatively, you generate a pack by providing a JSON string directly:

```shell
grand-challenge-forge pack --output-dir /tmp '{ "challenge": { "slug": "a-slug"...'
```

This will output a pack directory in the `/tmp` directory.

Via API pack generation can be done via:

``` Python
from grand_challenge_forge.forge import generate_challenge_pack
from Pathlib import Path

generate_challenge_pack(
    context={"challenge": {...}}
    output_path=Path("dist/"),
    delete_existing=False,
)
```

### ALGORITHM-TEMPLATE generation

```shell
grand-challenge-forge algorithm algorithm-context.json
```

Will use the context found in `algorithm-context.json` and generate a algorith-template directory at the current working directory in a directory `dist/` (default).

Alternatively, you generate an algorithm template by providing a JSON string directly:

```shell
grand-challenge-forge algorithm --output-dir /tmp '{ "algorithm": { ... } }'
```

This will output an algorithm-template directory in the `/tmp` directory.

Via API the algorithm-template generation can be done via:

``` Python
from grand_challenge_forge.forge import generate_algorithm_template
from Pathlib import Path

generate_algorithm_template(
    context={"algorithm": { ... }}
    output_path=Path("dist/"),
    delete_existing=False,
)
```

## 🏗️ Development

### Install locally

Install grand-challenge-forge locally (requires `poetry`):

```shell
git clone https://github.com/DIAGNijmegen/rse-grand-challenge-forge.git
cd rse-grand-challenge-forge
poetry install
poetry run grand-challenge-forge --help
```

### Pre-commit hooks

Several linters and stylers run to check the formatting during continuous integration. Ensure they are run before
committing by installing [pre-commit](https://pre-commit.com/).

### Running Tests

use `tox` to run all tests across all supported python versions:

```
pip install tox
tox
```

### Dependencies

Under the hood grand-challenge-forge uses:

* [Click](https://palletsprojects.com/p/click/)
  * a composable command line interface toolkit
* [Jinja2](https://github.com/alex-foundation/jinja2)
  * a utility that renders templates