initial commit

zhenyamorozov · Feb 12, 2024 · fb5e1ad · fb5e1ad
commit fb5e1ad
Show file tree

Hide file tree

Showing 21 changed files with 2,023 additions and 0 deletions.
diff --git a/.ebextensions/00-packages.config b/.ebextensions/00-packages.config
@@ -0,0 +1,3 @@
+packages:
+  yum:
+    git: []
diff --git a/.ebextensions/01-flask.config b/.ebextensions/01-flask.config
@@ -0,0 +1,3 @@
+option_settings:
+  "aws:elasticbeanstalk:container:python":
+    WSGIPath: web:app
diff --git a/.env.sample b/.env.sample
@@ -0,0 +1,48 @@
+# Dev parameters
+#FLASK_DEBUG=1
+FLASK_ENV=development
+FLASK_SECRET_KEY=shhhhh
+
+# Required parameters
+SHAREPOINT_CLIENT_ID = 
+SHAREPOINT_CLIENT_SECRET = 
+
+
+WEBEX_INTEGRATION_CLIENT_ID = 
+WEBEX_INTEGRATION_CLIENT_SECRET = 
+
+WEBEX_BOT_TOKEN = 
+WEBEX_BOT_ROOM_ID = 
+
+# Optional parameters
+SHAREPOINT_PARAMS = '{
+    "columns": {
+        "create": "Create", 
+        "startdatetime": "Start Date and Time (UTC)",  
+        "title": "Full Title for Webex Event", 
+        "agenda": "Description",
+        "cohosts": "Host(s)",
+        "panelists": "Presenters (comma separated +<email>)",
+        "webinarId": "Webinar ID",
+        "attendeeUrl": "Webex Attendee URL",
+        "hostKey": "Host Key",
+        "registrantCount": "Reg Count"
+    },
+    "nicknames": {
+        "john": {
+            "email": "johndoe@example.com",
+            "name": "John Doe"
+        }
+    }
+}'
+
+# alwaysInvitePanelists: list of people/calendars that are added as Panelists to all webinars
+# noCohosts: invite Cohosts as regular attendees, rather than actual cohosts
+WEBEX_INTEGRATION_PARAMS = '{
+    "siteUrl": "mysite.webex.com", 
+    "panelistPassword": "panelistsecret", 
+    "password": "attendeesecret",
+    "reminderTime": 30,
+    "alwaysInvitePanelists" : "Calendar <calendar@example.com>, Supervisor <supervisor@example.com>",
+    "noCohosts": false
+}'
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,163 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# VS Code
+.vscode/
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Eugene Morozov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.rst b/README.rst
@@ -0,0 +1,69 @@
+=====================================
+Sharepoint Lists and Webex Automation
+=====================================
+
+*Automatically create webinars in Webex Webinar based on information in a Sharepoint List*
+
+
+It is easy to use:
+
+Collaborate with your team on webinar planning. When ready for creation, check **Create=yes**
+
+.. image:: docs/images/sharepoint-prepare.gif
+    :width: 1500
+    :alt: Sharepoint Lists screenshot showing preparation of webinar data and marking webinars for creation
+
+Schedule all webinars with one bot command
+
+.. image:: docs/images/bot-schedule.gif
+    :width: 854
+    :alt: Webex bot screenshot showing clicking the Schedule Now button
+
+Webinars are created
+
+.. image:: docs/images/sharepoint-complete.gif
+    :width: 1500
+    :alt: Sharepoint Lists screenshot showing the scheduled webinars details appearing
+
+If need to change title, description, or reshedule, run the bot command again. You can also run it on a schedule.
+
+
+Features
+--------
+This automation ties together three different services: Sharepoint, Webex Meetings/Webinars and Webex Messaging bot. It helps a lot if you are running many webinars, especially in series, especially with multiple people collaborating on them.
+
+This automation supports:
+
+- Create and update Webex Webinars based on information in a Sharepoint list
+- Reports status via bot to a Webex space
+- Control with Webex bot adaptive cards
+- Creation can be triggered by bot command or by schedule
+- Customizable webinar parameters
+- Attendee link, host key and registrant count updated into the Sharepoint list
+
+
+How it works
+------------
+
+- Collect all webinar information in a Sharepoint list, one webinar per row. Include details like webinar title, description, date and time, hosts, panelists etc. The list can be shared by multiple people for teamwork.
+- Check out individual webinars for creation by changing the ``Create`` field to ``yes/True``. Save the changes.
+- Mention the @bot in the Webex room and click ``Schedule now`` button.
+- The scheduling will be triggered and the bot will report back after some seconds (or minutes, depending on your amount of webinars).
+
+
+Get Started
+-----------
+
+This automation requires a few things to be set up. Look for details in `Get Started <docs/get_started.rst>`_
+
+
+Contribute
+----------
+
+Feel free to fork and improve.
+
+
+Support
+-------
+
+This automation is offered as-is.