presentations (#1279)

* add presentation with fields to correctly build talks after recent change

* news

* feat: add hide option in presentations db to suppress printing a presentation in the list

* fix: add wxpython to conda install as it is needed for gooey but won't build from pip

* tests: add test for new presentation structure

Author: sbillinge

news/presentations.rst

@@ -0,0 +1,23 @@
+**Added:**
+
+* <news item>
+
+**Changed:**
+
+* a_presentation helper now adds new fields needed for new way of building talks
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>

requirements/conda.txt

@@ -1,4 +1,5 @@
 ruamel.yaml
+ruamel.yaml.clib
 bibtexparser
 docutils
 jinja2
@@ -14,4 +15,4 @@ matplotlib-base
 habanero
 google-api-python-client
 google-auth-oauthlib
-wxpython
+wxpython          # needed for gooey but can't build from pip

src/regolith/exemplars.json

@@ -1595,6 +1595,7 @@
             "begin_month": 5,
             "begin_day": 22,
             "department": "apam",
+            "hide": false,
             "institution": "columbiau",
             "location": "Upton NY",
             "meeting_name": "Meeting to check flexibility on dates",

src/regolith/helpers/a_presentationhelper.py

@@ -39,6 +39,9 @@ def subparser(subpi):
     )
     subpi.add_argument("begin_date", help="Input begin date for this presentation ", **date_kwargs)
     subpi.add_argument("end_date", help="Input end date for this presentation", **date_kwargs)
+    subpi.add_argument(
+        "--regolith-talk-id", help="the id of the talk in your regolith talks collection, if known", default="tbd"
+    )
     subpi.add_argument("-t", "--title", help="the title of the presentation, default is tbd", default="tbd")
     subpi.add_argument("-a", "--abstract", help="abstract of the presentation, defaults to tbd", default="tbd")
     subpi.add_argument(
@@ -268,8 +271,10 @@ def db_updater(self):
         pdoc.update(
             {
                 "project": ["all"],
+                "presenter": rc.person,
                 "status": rc.status,
                 "title": rc.title,
+                "talk_id": rc.regolith_talk_id,
                 "type": rc.type,
             }
         )

src/regolith/schemas.json

@@ -1951,6 +1951,11 @@
             "anyof_type": ["string", "integer"]
         },
         "end_day": {"required": false, "type": "integer"},
+        "hide": {
+            "description": "Whether the presentation should be hidden in the presentation list",
+            "required": false,
+            "type": "boolean"
+        },
         "institution": {
             "description": "institution where thepresentation will be made, if applicable.",
             "required": false,

src/regolith/tools.py

@@ -602,6 +602,9 @@ def filter_presentations(
     fourthclean = list()
     presclean = list()
 
+    # remove presentations that have hide: True
+    presentations = [pres for pres in presentations if not pres.get("hide", False)]
+
     # build the filtered collection
     # only list the talk if the group member is an author
     for pres in presentations:

tests/outputs/a_presentation/presentations.yaml

@@ -51,6 +51,7 @@
   begin_month: 5
   begin_year: 2018
   department: apam
+  hide: false
   institution: columbiau
   location: Upton NY
   meeting_name: Meeting to check flexibility on dates
@@ -77,8 +78,10 @@
     - This is to test Case C.2 where user wants an expense added and passed the 
       force option without specifying an expense db when default is public
   presentation_url: http://drive.google.com/SEV356DV
+  presenter: nasker
   project:
     - all
   status: in-prep
+  talk_id: tbd
   title: Testing Case C.2
   type: contributed_oral