Commit 44b29008 authored by Dimitri Podborski's avatar Dimitri Podborski
Browse files

Update README.md

parent fabb3978
......@@ -39,12 +39,17 @@ deactivate
## 2. systems.py
`systems.py` is a script which is intended to be used in the Systems group. Use the `-h` option to see all available parameters. This script allows you to:
`systems.py` is a script which is intended to be used in the Systems group. Use the `-h` option to see all available parameters.
To provide input data to the script you can either:
- use `--csv` option to use the CSV file
- or use `-m` (`--documents`) together with `-p` (`--project`) options
Below are a few examples:
1. Open issues based on the information provided in a CSV file:
e.g.: `python systems.py -o --csv Contribs.csv`
2. Open issues based on CLI options:
e.g.: `python3 systems.py -o -m 55958,55959,56121 -p FileFormat/CENC --meeting 133`
e.g.: `python systems.py -o -m 55958,55959,56121 -p FileFormat/CENC --meeting 133`
3. Generate an output document based on the information provided in a CSV file. Use a template as a basis (`--template` is optional):
e.g.: `python systems.py -d --csv Contribs.csv --template template.docx`
4. Close issues based on the information provided in a CSV file:
......@@ -60,8 +65,8 @@ The CSV file must have a header row with the folowing entries:
- To determine which GitLab project needs to be used make sure that your CSV file has either:
- **Project URL** - a full URL to your GitLab project (*recommended*)
- or **Sub Group** and **Project Name** - two last elements of the Project URL. (non-case-sensitive)
e.g.: `http://mpegx.int-evry.fr/software/MPEG/Systems/PCC-SYS/V-PCC` → `Sub Group = PCC-SYS` and `Project Name = V-PCC`.
e.g.: `http://mpegx.int-evry.fr/software/MPEG/Systems/FileFormat/isobmff` → `Sub Group = FileFormat` and `Project Name = ISOBMFF`
e.g.: http://mpegx.int-evry.fr/software/MPEG/Systems/PCC-SYS/V-PCC → `Sub Group=PCC-SYS`, `Project Name=V-PCC`.
e.g.: http://mpegx.int-evry.fr/software/MPEG/Systems/FileFormat/isobmff → `Sub Group=FileFormat`, `Project Name=ISOBMFF`
- **Close issue** - is required if you want to close multiple issues at once. Supported values are `0`, `1`, `TRUE`, `FALSE`, `true` and `false`.
The example CSV below has both `Project URL` and (`Sub Group` with `Project Name`) but you can also have one of these in your CSV. The CSV delimiter is determined automatically.
......
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