Disable networking in test runs and minor tweaks to docs

README.md

@@ -1,13 +1,14 @@
-[![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)
+
 
 #  🛠️ 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:
@@ -17,7 +18,7 @@ pip install grand-challenge-forge
 grand-challenge-forge --help
 ```
 
-## 🎒 Challenge packs
+## 📦 Challenge packs
 
 A challenge pack consists of challenge-tailored examples for the following:
 * A script to _automate uploading_ data to an archive
@@ -118,7 +119,7 @@ This will output a pack directory in the `/tmp` directory.
 ## 🏗️ Development
 
 ### Install locally
-Install locally grand-challenge-forge locally (requires `poetry`):
+Install grand-challenge-forge locally (requires `poetry`):
 
 ```shell
 git clone https://github.com/DIAGNijmegen/rse-grand-challenge-forge.git
@@ -128,15 +129,15 @@ poetry run grand-challenge-forge --help
 ```
 
 ### Pre-commit hooks
-Several linters and stylers run to check the formating during continuous integration. Ensure they are run before
+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
+pip install tox
+tox
 ```
 
 ### Dependencies

grand_challenge_forge/cli.py

@@ -85,13 +85,14 @@ def cli(output, force, contexts, no_quality_control, verbose=0):
                     force=force,
                     quality_control_registry=quality_control_registry,
                 )
-                logger.info(f"🎒 Created Pack {pack_dir.stem!r}")
+                logger.info(f"📦 Created Pack {pack_dir.stem!r}")
                 if quality_control_registry:
                     logger.info("👷 Starting quality checks...")
                     for check in quality_control_registry:
                         check()
-                    logger.info("✅  Quality checks complete!")
+                    logger.info("✅ Quality checks complete!")
                 logger.info(f"📢 Pack is here: {pack_dir}")
+                print(str(pack_dir))
             except Exception as e:
                 if isinstance(e, ChallengeForgeError):
                     logger.error(f"💔 {e}")

grand_challenge_forge/partials/example-algorithm/example-algorithm{{cookiecutter._}}/test_run.sh.j2

@@ -31,6 +31,7 @@ docker build "$SCRIPT_DIR" \
 echo "=+= Doing a forward pass"
 docker run --rm \
     --platform=linux/amd64 \
+    --network none \
     {% if "_no_gpus" not in cookiecutter or not cookiecutter._no_gpus -%}
     --gpus all \
     {% endif -%}

grand_challenge_forge/partials/example-evaluation-method/example-evaluation-method{{cookiecutter._}}/test_run.sh.j2

@@ -31,6 +31,7 @@ docker build "$SCRIPT_DIR" \
 echo "=+= Doing an evaluation"
 docker run --rm \
     --platform=linux/amd64 \
+    --network none \
     {% if "_no_gpus" not in cookiecutter or not cookiecutter._no_gpus -%}
     --gpus all \
     {% endif -%}

grand_challenge_forge/partials/pack-readme/{{cookiecutter.pack_dir_name}}/README.md.j2

@@ -1,4 +1,4 @@
-# 🎒 {{cookiecutter.challenge.slug}} challenge pack
+# 📦 {{cookiecutter.challenge.slug}} challenge pack
 Thank you for hosting your challenge on Grand-Challenge.org. We appreciate it!
 
 ## Content

grand_challenge_forge/partials/upload-to-archive-script/upload-to-archive-{{cookiecutter.phase.archive.slug}}/upload_files.py.j2

@@ -24,6 +24,9 @@ will be filled with the result of this post-processing.
 Check your uploaded results here:
  {{ cookiecutter.phase.archive.url }}
 
+And the intermediate processing state here:
+  https://grand-challenge.org/cases/uploads/
+
 Happy uploading!
 """