Merge branch 'refactoring' into 'master'

release 1.4

Closes #197 and #199

See merge request !5

.gitignore

@@ -46,6 +46,11 @@ Temporary Items
 # Local History for Visual Studio Code
 .history/
 
+####################################
+# IntelliJ
+####################################
+.idea/*
+
 ####################################
 # Python
 ####################################

README.md

@@ -51,32 +51,29 @@ 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.: `python systems.py -o -m 55958,55959,56121 -p FileFormat/CENC --meeting 133`
+e.g.: `python systems.py -o -m 55958,55959,56121 -p http://... --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:  
 e.g.: `python systems.py -c --csv Contribs.csv`
 5. Close issues based on CLI options:  
-e.g.: `python systems.py -c -m m55958,m55959,m56121 -p FileFormat/CENC --meeting 133`
+e.g.: `python systems.py -c -m m55958,m55959,m56121 -p http://... --meeting 133`
 6. Print information about input documents on MDMS and GitLab:  
-e.g.: `python systems.py -l -m m55958,m55959,m56121 -p FileFormat/CENC --meeting 133`
+e.g.: `python systems.py -l -m m55958,m55959,m56121 -p http://... --meeting 133`
 
 The CSV file must have a header row with the folowing entries:
 
-- **Number** - MPEG document number with entries like `m12345`
-- 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`, `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`.
+- **Number** - MPEG document numbers
+- **Project URL** - a full URL to your GitLab project
+- **Close issue** - (optional) 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.
+The CSV delimiter is determined automatically. The order of columns does not matter. CSV file example:
 
 ```csv
-Number;Title;Project URL;Sub Group;Project Name
-m55958;On item encryption;http://mpegx.int-evry.fr/software/MPEG/Systems/FileFormat/CENC;FileFormat;CENC
-m55959;On multi-key encryption;http://mpegx.int-evry.fr/software/MPEG/Systems/FileFormat/CENC;FileFormat;CENC
+Number;Whatever column;Project URL
+m55958;On item encryption;http://mpegx.int-evry.fr/software/MPEG/Systems/FileFormat/CENC
+m55959;On multi-key encryption;http://mpegx.int-evry.fr/software/MPEG/Systems/FileFormat/CENC
+...
 ```
 
 ## 3. generate_ballot_issues.py

automation/__init__.py

-# init automation package 
+# init automation package
\ No newline at end of file

automation/gitlab.py

 # -*- coding: utf-8 -*-
-'''
+"""
 This is the interface to MPEG GitLab API.
-'''
+"""
 
 import os
 import gitlab
@@ -10,98 +10,107 @@ from enum import Enum, unique
 BASE_URL = 'http://mpegx.int-evry.fr/software'
 TOKEN = os.environ.get('GITLAB_TOKEN')
 
+
 @unique
 class Label(Enum):
-  Accepted = 'Accepted'
-  BallotComment = 'BallotComment'
-  Combined = 'Combined'
-  DocAvailable = 'DocAvailable'
-  Editorial = 'Editorial'
-  Late = 'Late'
-  NeedsRevision = 'NeedsRevision'
-  Noted = 'Noted'
-  Postponed = 'Postponed'
-  ProbableAgreement = 'ProbableAgreement'
-  Rejected = 'Rejected'
-  Revised = 'Revised'
-  SeeDoCR = 'SeeDoCR'
-  Withdrawn = 'Withdrawn'
+    Accepted = 'Accepted'
+    BallotComment = 'BallotComment'
+    Combined = 'Combined'
+    DocAvailable = 'DocAvailable'
+    Editorial = 'Editorial'
+    Late = 'Late'
+    NeedsRevision = 'NeedsRevision'
+    Noted = 'Noted'
+    Postponed = 'Postponed'
+    ProbableAgreement = 'ProbableAgreement'
+    Rejected = 'Rejected'
+    Revised = 'Revised'
+    SeeDoCR = 'SeeDoCR'
+    Withdrawn = 'Withdrawn'
+
 
 # private token authentication
 GL = gitlab.Gitlab(BASE_URL, private_token=TOKEN)
 try:
-  GL.auth()
-  print('GitLab API: Authenticated as "{}"'.format(GL.user.username))
+    GL.auth()
+    print('GitLab API: Authenticated as "{}"'.format(GL.user.username))
 except gitlab.exceptions.GitlabAuthenticationError:
-  print('Error: Could not authenticate. Please set the valid private GITLAB_TOKEN env. variable.')
-  GL = None
+    print('Error: Could not authenticate. Please set the valid private GITLAB_TOKEN env. variable.')
+    GL = None
 
 
 def _get_project(project_id):
-  if not GL:
-    print('Error: GitLab API authentication failed.')
-    return
-  try:
-    project = GL.projects.get(project_id)
-  except gitlab.exceptions.GitlabGetError as err:
-    print('project_id', project_id, err)
-    return None
-  return project
+    if not GL:
+        print('Error: GitLab API authentication failed.')
+        return
+    try:
+        project = GL.projects.get(project_id)
+    except gitlab.exceptions.GitlabGetError as err:
+        print('project_id', project_id, err)
+        return None
+    return project
+
 
 # --------------------------------------------------------------------------------------------------
 # Interfaces
 # --------------------------------------------------------------------------------------------------
 
 def get_projects():
-  if not GL:
-    print('Error: GitLab API authentication failed.')
-    return []
-  projects = GL.projects.list(all=True)
-  projects_stripped = []
-  for project in projects:
-    projects_stripped.append({
-      'id': project.id,
-      'name': project.name,
-      'url': project.web_url,
-      'path_with_namespace': project.path_with_namespace,
-      'description': project.description
-    })
-  return projects_stripped
+    if not GL:
+        print('Error: GitLab API authentication failed.')
+        return []
+    projects = GL.projects.list(all=True)
+    projects_stripped = []
+    for project in projects:
+        projects_stripped.append({
+            'id': project.id,
+            'name': project.name,
+            'url': project.web_url,
+            'path_with_namespace': project.path_with_namespace,
+            'description': project.description
+        })
+    return projects_stripped
+
 
 def get_members(group_id):
-  if not GL:
-    print('Error: GitLab API authentication failed.')
-    return []
-  group = GL.groups.get(group_id)
-  subgroups = group.subgroups.list()
-  members_stripped = {}
-  for subgroup in subgroups:
-    real_group = GL.groups.get(subgroup.id, lazy=True)
-    members = real_group.members.all(all=True)
-    for member in members:
-      if not member.username in members_stripped:
-        members_stripped[member.username] = {
-          'id': member.id,
-          'name': member.name,
-          'url': member.web_url
-        }
-  return members_stripped
+    if not GL:
+        print('Error: GitLab API authentication failed.')
+        return []
+    group = GL.groups.get(group_id)
+    subgroups = group.subgroups.list()
+    members_stripped = {}
+    for subgroup in subgroups:
+        real_group = GL.groups.get(subgroup.id, lazy=True)
+        members = real_group.members.all(all=True)
+        for member in members:
+            if member.username not in members_stripped:
+                members_stripped[member.username] = {
+                    'id': member.id,
+                    'name': member.name,
+                    'url': member.web_url
+                }
+    return members_stripped
+
 
 def get_issues(project_id):
-  project = _get_project(project_id)
-  if not project:
-    return []
-  issues = project.issues.list(state='opened', all=True)
-  return issues
-
-def open_issue(project_id, title, description, labels=[]):
-  project = _get_project(project_id)
-  if not project:
-    return
-  issue = project.issues.create({'title': title, 'description': description, 'labels': labels})
-  issue.save()
+    project = _get_project(project_id)
+    if not project:
+        return []
+    issues = project.issues.list(state='opened', all=True)
+    return issues
 
-def close_issue(issue):
-  if isinstance(issue, gitlab.v4.objects.ProjectIssue):
-    issue.state_event = 'close'
+
+def open_issue(project_id, title, description, labels=None):
+    project = _get_project(project_id)
+    if not project:
+        return
+    if labels is None:
+        labels = []
+    issue = project.issues.create({'title': title, 'description': description, 'labels': labels})
     issue.save()
+
+
+def close_issue(issue):
+    if isinstance(issue, gitlab.v4.objects.ProjectIssue):
+        issue.state_event = 'close'
+        issue.save()

examples/example_gitlab.py

-'''
+"""
 Just a few examples on how to use gitlab module
-'''
+"""
 import sys
-sys.path.append('..') # hack which allows to import module from the parent directory
+
+sys.path.append('..')  # hack which allows to import module from the parent directory
 from automation import gitlab
 
 # get all projects
 projects = gitlab.get_projects()
 print('project count:', len(projects))
 for project in projects:
-  print(project)
+    print(project)
 
 issues = gitlab.get_issues(projects[0]['id'])
-print('project {} has {} issues.'.format(projects[0]['url'], len(issues)))
+print('project {} has {} issues.'.format(projects[0]['url'], len(issues)))
\ No newline at end of file

examples/example_mdms.py

-'''
+"""
 Just a few examples on how to use mdms module
-'''
+"""
 import sys
-sys.path.append('..') # hack which allows to import module from the parent directory
+
+sys.path.append('..')  # hack which allows to import module from the parent directory
 from automation import mdms
 
 # Get all meetings
@@ -11,7 +12,8 @@ print('Number of MPEG meetings:', len(meetings))
 
 # Get latest meeting, (this calles mdms.get_meetings() internally)
 last_meeting = mdms.get_current_meeting()
-print('\nLast MPEG#{} ({}) from {} to {}'.format(last_meeting['number'], last_meeting['name'], last_meeting['start_date'], last_meeting['end_date']))
+print('\nLast MPEG#{} ({}) from {} to {}'.format(last_meeting['number'], last_meeting['name'],
+                                                 last_meeting['start_date'], last_meeting['end_date']))
 
 # Get all input documents of a certain meeting
 input_docs = mdms.get_input_documents(last_meeting['id'])