Commit e9a8d1f0 authored by Cyril Matthey-Doret's avatar Cyril Matthey-Doret
Browse files

add example help message in readme

parent c3910216
Pipeline #388570 passed with stage
in 12 seconds
......@@ -32,7 +32,25 @@ pip install git+https://renkulab.io/gitlab/learn-renku/teaching-on-renku/advance
## Usage
Once the package is installed, the command `teach-auto` will be available globally on your system. Each functionality is available as a subcommand. For example `teach-auto collect-forks`. Each command stands in its own python script which can also be executed directly, e.g. `python teach_auto/collect_forks.py`. Each command provides a `--help` flag to print the list of available options and usage information.
Once the package is installed, the command `teach-auto` will be available globally on your system. Each functionality is available as a subcommand. For example `teach-auto collect-forks`. Each command stands in its own python script which can also be executed directly, e.g. `python teach_auto/collect_forks.py`. Each command provides a `--help` flag to print the list of available options and usage information:
```sh
➜ teach-auto --help
Usage: teach-auto [OPTIONS] COMMAND [ARGS]...
teach-auto: Classroom automation utilities for Gitlab + Renku.
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
clone-forks Clone all forks from input JSON into target directory.
collect-forks Gather metadata about all forks of input project into...
create-groups Given a parent-group URL and a CSV file of students...
invite-students Send invitations to join input gitlab group to all...
send-feedback Send feedback to repositories in input JSON by opening...
```
Most functionalities below require a Gitlab API token. By default, you will be prompted for your token upon running the scripts, but you can also provide it as a plain text file with the `--token` option.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment