Commit 944f7c47 authored by Dimitri Podborski's avatar Dimitri Podborski 😂
Browse files

Update README.md

add some examples for Sub Group and Project Name
parent 564852f0
......@@ -6,14 +6,16 @@ You can use MDMS and GitLab modules in your own scripts. An example how to use t
:bulb: New ideas are welcome. Open new issues for your ideas. The general idea is to fire requests to MDMS, process the information, use gitlab API to open issues.
## Requirements
## 1. Requirements
### Environment variables
- `MPEG_LOGIN` - [MDMS](https://dms.mpeg.expert) login
- `MPEG_PWD` - [MDMS](https://dms.mpeg.expert) password
- `MPEG_LOGIN` - [MDMS](https://dms.mpeg.expert) group login
- `MPEG_PWD` - [MDMS](https://dms.mpeg.expert) group password (changes every meeting)
- `GITLAB_TOKEN` - your private GitLab token with API scope. You can create your token [here](http://mpegx.int-evry.fr/software/profile/personal_access_tokens).
Just in case you are not familiar with Environment Variables you can follow [this Guide](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html) to set everything up.
### Python3
It is recommended to use python [virtual environment](https://docs.python.org/3/library/venv.html#module-venv).
......@@ -27,29 +29,32 @@ source venv/bin/activate
pip install -r requirements.txt
(run your scripts)
(e.g.: python systems.py --csv Contribs.csv -o ... )
deactivate
```
## systems.py
## 2. systems.py
`systems.py` is a script which is intended to be used in the Systems group. It takes a CSV file as an input and allows you to:
1. Print information about input documents on MDMS and GitLab (optional):
1. Print information about input documents on MDMS and GitLab (`-p` is optional):
e.g.: `python systems.py -m m55958,m55959,m56121 -p FileFormat/CENC --meeting 133`
2. Open issues based on the information provided in a CSV file:
2. Open issues based on the information provided in a CSV file:
e.g.: `python systems.py --csv Contribs.csv -i`
3. Generate an output document based on the information provided in a CSV file. Use a template (optional) as a basis:
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 --csv Contribs.csv -o --template templates/WG03_input_template_dimitri.docx`
The CSV file must have a header row with the folowing entries:
- `Number` - MPEG document number e.g. m12345
- To determine which GitLab project needs to be used make sure that your CSV file has either:
- `Project URL`
- or `Sub Group` with `Project Name`
- `Project URL` - a full URL to your GitLab project
- 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`
The example 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.
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.
```csv
Number;Title;Project URL;Sub Group;Project Name
......@@ -57,6 +62,6 @@ m55958;On item encryption;http://mpegx.int-evry.fr/software/MPEG/Systems/FileFor
m55959;On multi-key encryption;http://mpegx.int-evry.fr/software/MPEG/Systems/FileFormat/CENC;FileFormat;CENC
```
## generate_ballot_issues.py
## 3. generate_ballot_issues.py
A simple script to generate issues for each ballot comment from a document received from ISO.
Supports Markdown
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