gam7 7.23.0__tar.gz → 7.23.2__tar.gz

{gam7-7.23.0 → gam7-7.23.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gam7
-Version: 7.23.0
+Version: 7.23.2
 Summary: CLI tool to manage Google Workspace
 Project-URL: Homepage, https://github.com/GAM-team/GAM
 Project-URL: Issues, https://github.com/GAM-team/GAM/issues

{gam7-7.23.0 → gam7-7.23.2}/src/GamCommands.txt

@@ -3383,6 +3383,7 @@ gam print course-materials [todrive <ToDriveAttribute>*]
         (orderby <CourseMaterialOrderByFieldName> [ascending|descending])*)
         [showcreatoremails|creatoremail] [showtopicnames] [fields <CourseMaterialFieldNameList>]
         [timefilter creationtime|updatetime|scheduledtime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
+        [oneitemperrow]
         [countsonly] [formatjson [quotechar <Character>]]
 gam print course-submissions [todrive <ToDriveAttribute>*]
         (course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] states <CourseStateList>])
@@ -3404,6 +3405,7 @@ gam print course-works [todrive <ToDriveAttribute>*]
         [showcreatoremails|creatoremail] [showtopicnames] [fields <CourseWorkFieldNameList>]
         [showstudentsaslist [<Boolean>]] [delimiter <Character>]
         [timefilter creationtime|updatetime|scheduledtime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
+        [oneitemperrow]
         [countsonly] [formatjson [quotechar <Character>]]
 
 # Classroom - Student Groups

{gam7-7.23.0 → gam7-7.23.2}/src/GamUpdate.txt

@@ -1,3 +1,9 @@
+7.23.02
+
+Added option `oneitemperrow` to 'gam print course-materials|course-work` to have each of a
+course's materials displayed on a separate row with all of the other course fields.
+This produces a CSV file that can be used in subsequent commands to process the materials without further script processing.
+
 7.23.00
 
 Added `chat_max_results` variable to `gam.cfg`.

{gam7-7.23.0 → gam7-7.23.2}/src/gam/__init__.py

@@ -25,7 +25,7 @@ https://github.com/GAM-team/GAM/wiki
 """
 
 __author__ = 'GAM Team <google-apps-manager@googlegroups.com>'
-__version__ = '7.23.00'
+__version__ = '7.23.02'
 __license__ = 'Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)'
 
 #pylint: disable=wrong-import-position
@@ -49473,6 +49473,16 @@ def doPrintCourseWM(entityIDType, entityStateType):
       pass
     return topicNames
 
+  def _printCourseWMrow(course, courseWM):
+    row = flattenJSON(courseWM, flattened={'courseId': course['id'], 'courseName': course['name']}, timeObjects=TimeObjects,
+                      simpleLists=['studentIds'] if showStudentsAsList else None, delimiter=delimiter)
+    if not FJQC.formatJSON:
+      csvPF.WriteRowTitles(row)
+    elif csvPF.CheckRowTitles(row):
+      csvPF.WriteRowNoFilter({'courseId': course['id'], 'courseName': course['name'],
+                              'JSON': json.dumps(cleanJSON(courseWM, timeObjects=TimeObjects),
+                                                 ensure_ascii=False, sort_keys=True)})
+
   def _printCourseWM(course, courseWM, i, count):
     if applyCourseItemFilter and not _courseItemPassesFilter(courseWM, courseItemFilter):
       return
@@ -49484,14 +49494,13 @@ def doPrintCourseWM(entityIDType, entityStateType):
       topicId = courseWM.get('topicId')
       if topicId:
         courseWM['topicName'] = topicNames.get(topicId, topicId)
-    row = flattenJSON(courseWM, flattened={'courseId': course['id'], 'courseName': course['name']}, timeObjects=TimeObjects,
-                      simpleLists=['studentIds'] if showStudentsAsList else None, delimiter=delimiter)
-    if not FJQC.formatJSON:
-      csvPF.WriteRowTitles(row)
-    elif csvPF.CheckRowTitles(row):
-      csvPF.WriteRowNoFilter({'courseId': course['id'], 'courseName': course['name'],
-                              'JSON': json.dumps(cleanJSON(courseWM, timeObjects=TimeObjects),
-                                                 ensure_ascii=False, sort_keys=True)})
+    if not oneItemPerRow or not courseWM.get('materials', []):
+      _printCourseWMrow(course, courseWM)
+    else:
+      courseMaterials = courseWM.pop('materials')
+      for courseMaterial in courseMaterials:
+        courseWM['materials'] = courseMaterial
+        _printCourseWMrow(course, courseWM)
 
   croom = buildGAPIObject(API.CLASSROOM)
   if entityIDType == Ent.COURSE_WORK_ID:
@@ -49529,7 +49538,7 @@ def doPrintCourseWM(entityIDType, entityStateType):
   courseShowProperties = _initCourseShowProperties(['name'])
   OBY = OrderBy(OrderbyChoiceMap)
   creatorEmails = {}
-  showCreatorEmail = showTopicNames = False
+  oneItemPerRow = showCreatorEmail = showTopicNames = False
   delimiter = GC.Values[GC.CSV_OUTPUT_FIELD_DELIMITER]
   countsOnly = showStudentsAsList = False
   while Cmd.ArgumentsRemaining():
@@ -49546,6 +49555,9 @@ def doPrintCourseWM(entityIDType, entityStateType):
       pass
     elif myarg == 'orderby':
       OBY.GetChoice()
+    elif myarg == 'oneitemperrow':
+      oneItemPerRow = True
+      csvPF.RemoveIndexedTitles('materials')
     elif myarg in {'showcreatoremails', 'creatoremail'}:
       showCreatorEmail = True
     elif myarg == 'showtopicnames':
@@ -49626,6 +49638,7 @@ def doPrintCourseWM(entityIDType, entityStateType):
 #	(orderby <CourseMaterialsOrderByFieldName> [ascending|descending])*)
 #	[showcreatoremails|creatoremail] [showtopicnames] [fields <CourseMaterialFieldNameList>]
 #	[timefilter creationtime|updatetime|scheduledtime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
+#	[oneitemperrow]
 #	[countsonly] [formatjson [quotechar <Character>]]
 def doPrintCourseMaterials():
   doPrintCourseWM(Ent.COURSE_MATERIAL_ID, Ent.COURSE_MATERIAL_STATE)
@@ -49637,6 +49650,7 @@ def doPrintCourseMaterials():
 #	[showcreatoremails|creatoremail] [showtopicnames] [fields <CourseWorkFieldNameList>]
 #	[showstudentsaslist [<Boolean>]] [delimiter <Character>]
 #	[timefilter creationtime|updatetime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
+#	[oneitemperrow]
 #	[countsonly] [formatjson [quotechar <Character>]]
 def doPrintCourseWork():
   doPrintCourseWM(Ent.COURSE_WORK_ID, Ent.COURSE_WORK_STATE)

{gam7-7.23.0 → gam7-7.23.2}/wiki/Classroom-Courses.md

@@ -570,6 +570,7 @@ gam print course-materials [todrive <ToDriveAttribute>*]
         (orderby <CourseMaterialOrderByFieldName> [ascending|descending])*)
         [showcreatoremails|creatoremail] [showtopicnames] [fields <CourseMaterialFieldNameList>]
         [timefilter creationtime|updatetime|scheduledtime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
+        [oneitemperrow]
         [countsonly] [formatjson [quotechar <Character>]]
 ```
 By default, the `print course-materials` command displays course materials information for all courses.
@@ -600,6 +601,10 @@ By default, all course materials fields are displayed; use the following options
 * `showtopicnames` - Display topic names; requires and additional API call per course.
 * `fields <CourseMaterialsFieldNameList>` - Select specific fields to display.
 
+With `print course-materials`, the materials selected for display are all output on one row/line as a repeating item with the other course fields.
+When `oneitemperrow` is specified, each material is output on a separate row/line with the other course fields.
+This simplifies processing the materials in the CSV file with subsequent Gam commands.
+
 Use the `countsonly` option to display the number of course materials in a course but not their details.
 
 By default, Gam displays the information as columns of fields; the following option causes the output to be in JSON format,
@@ -662,6 +667,7 @@ gam print course-work [todrive <ToDriveAttribute>*]
         [showcreatoremails] [showtopicnames] [fields <CourseWorkFieldNameList>]
         [showstudentsaslist [<Boolean>]] [delimiter <Character>]
         [timefilter creationtime|updatetime|scheduledtime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
+        [oneitemperrow]
         [countsonly] [formatjson [quotechar <Character>]]
 ```
 By default, the `print course-work` command displays course work information for all courses.
@@ -695,6 +701,10 @@ By default, all course work fields are displayed; use the following options to m
 By default, when course work is assigned to individual students, the student IDs are displayed in multiple indexed columns.
 Use options `showstudentsaslist [<Boolean>]` and `delimiter <Character>` to display the student IDs is a single column as a delimited list.
 
+With `print course-work`, any materials are all output on one row/line as a repeating item with the other course fields.
+When `oneitemperrow` is specified, each material is output on a separate row/line with the other course fields.
+This simplifies processing the materials in the CSV file with subsequent Gam commands.
+
 Use the `countsonly` option to display the number of course works in a course but not their details.
 
 By default, Gam displays the information as columns of fields; the following option causes the output to be in JSON format,

{gam7-7.23.0 → gam7-7.23.2}/wiki/GamUpdates.md

@@ -10,6 +10,24 @@ Add the `-s` option to the end of the above commands to suppress creating the `g
 
 See [Downloads-Installs-GAM7](https://github.com/GAM-team/GAM/wiki/Downloads-Installs) for Windows or other options, including manual installation
 
+### 7.23.01
+
+Added option `oneitemperrow` to 'gam print course-materials|course-work` to have each of a
+course's materials displayed on a separate row with all of the other course fields.
+This produces a CSV file that can be used in subsequent commands to process the materials without further script processing.
+
+### 7.23.00
+
+Added `chat_max_results` variable to `gam.cfg`.
+```
+chat_max_results
+    When retrieving lists of Chat items from API,
+    how many should be retrieved in each API call
+    Default: 100
+    Range: 1 - 1000
+```
+Previously, this vaule was always set to 1000 which could cause errors.
+
 ### 7.22.07
 
 Added options `showdetails` and `returnidonly` to `gam create|copy vaultquery`.

{gam7-7.23.0 → gam7-7.23.2}/wiki/How-to-Upgrade-Legacy-GAM-to-GAM7.md

@@ -252,7 +252,7 @@ writes the credentials into the file oauth2.txt.
 admin@server:/Users/admin$ rm -f /Users/admin/GAMConfig/oauth2.txt
 admin@server:/Users/admin$ gam version
 WARNING: Config File: /Users/admin/GAMConfig/gam.cfg, Section: DEFAULT, Item: oauth2_txt, Value: /Users/admin/GAMConfig/oauth2.txt, Not Found
-GAM 7.22.07 - https://github.com/GAM-team/GAM - pyinstaller
+GAM 7.23.01 - https://github.com/GAM-team/GAM - pyinstaller
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.7 64-bit final
 MacOS Sequoia 15.6.1 x86_64

{gam7-7.23.0 → gam7-7.23.2}/wiki/Version-and-Help.md

@@ -3,7 +3,7 @@
 Print the current version of Gam with details
 ```
 gam version
-GAM 7.22.07 - https://github.com/GAM-team/GAM - pyinstaller
+GAM 7.23.01 - https://github.com/GAM-team/GAM - pyinstaller
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.7 64-bit final
 macOS Sequoia 15.7 x86_64
@@ -15,7 +15,7 @@ Time: 2023-06-02T21:10:00-07:00
 Print the current version of Gam with details and time offset information
 ```
 gam version timeoffset
-GAM 7.22.07 - https://github.com/GAM-team/GAM - pyinstaller
+GAM 7.23.01 - https://github.com/GAM-team/GAM - pyinstaller
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.7 64-bit final
 macOS Sequoia 15.7 x86_64
@@ -27,7 +27,7 @@ Your system time differs from www.googleapis.com by less than 1 second
 Print the current version of Gam with extended details and SSL information
 ```
 gam version extended
-GAM 7.22.07 - https://github.com/GAM-team/GAM - pyinstaller
+GAM 7.23.01 - https://github.com/GAM-team/GAM - pyinstaller
 GAM Team <google-apps-manager@googlegroups.com>
 Python 3.13.7 64-bit final
 macOS Sequoia 15.7 x86_64

{gam7-7.23.0 → gam7-7.23.2}/wiki/gam.cfg.md

@@ -109,6 +109,11 @@ charset
         Character set of gam batch, gam csv, gam loop files.
         Default: utf-8
         Environment variable: GAM_CHARSET
+chat_max_results
+        When retrieving lists of Chat items from API,
+        how many should be retrieved in each API call
+        Default: 100
+        Range: 1 - 1000
 classroom_max_results
         When retrieving lists of Google Classroom items from API,
         how many should be retrieved in each API call