Fix PEP8 issues and format consistently

Resolves PEP8 requirement #211

- Format using black
- Format using ruff
- Manually fix remaining flake8 errors

Author: cmlccie

.flake8

@@ -11,13 +11,14 @@ ignore =
     # W503 line break before binary operator
     W503,
 exclude =
+    __pycache__,
     .git/,
     .idea/,
     .venv/,
     .vscode/,
-    __pycache__,
     dist/,
     docs/conf.py,
+    generator/templates/,
     venv/,
     versioneer.py,
     webexteamssdk/_version.py,

.ruff.toml

@@ -0,0 +1,25 @@
+line-length = 79
+
+# B: flake8-bugbear
+# Q: flake8-quotes
+extend-select = [ "B", "Q", "W" ]
+
+ignore-init-module-imports = true
+
+extend-exclude = [
+    "versioneer.py",
+    "webexteamssdk/_version.py",
+    "generator/**",
+]
+
+[lint]
+ignore = [
+    # E402 module level import not at top of file
+    "E402",
+    # F401 'builtins.*' imported but unused
+    "F401",
+    # F403 'from builtins import *' used; unable to detect undefined names
+    "F403",
+    # F405 'unicode' may be undefined, or defined from star imports: builtins
+    "F405",
+]

docs/conf.py

@@ -4,71 +4,69 @@
 import sys
 
 
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
 
 from webexteamssdk._version import get_versions
 
 
-project = u'webexteamssdk'
-copyright = u'Copyright (c) 2016-2020 Cisco and/or its affiliates.'
-author = u'Chris Lunsford'
-version = get_versions()['version']
-release = get_versions()['version']
+project = "webexteamssdk"
+copyright = "Copyright (c) 2016-2020 Cisco and/or its affiliates."
+author = "Chris Lunsford"
+version = get_versions()["version"]
+release = get_versions()["version"]
 language = None
 
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.doctest',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.coverage',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.napoleon',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
 ]
 
 
-master_doc = 'index'
-source_suffix = '.rst'
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-templates_path = ['_templates']
-pygments_style = 'sphinx'
+master_doc = "index"
+source_suffix = ".rst"
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+templates_path = ["_templates"]
+pygments_style = "sphinx"
 
 
 add_module_names = False
-autodoc_member_order = 'bysource'
+autodoc_member_order = "bysource"
 # autodoc_default_flags = ['members', 'undoc-members']
 autodoc_default_options = {
-    'members': None,
-    'undoc-members': None,
+    "members": None,
+    "undoc-members": None,
 }
 
 
 todo_include_todos = True
 
 
-
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-#html_theme = 'alabaster'
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+# html_theme = 'alabaster'
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
 if not on_rtd:
     import sphinx_rtd_theme
-    html_theme = 'sphinx_rtd_theme'
+
+    html_theme = "sphinx_rtd_theme"
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-html_theme_options = {
-    'collapse_navigation': False
-}
+html_theme_options = {"collapse_navigation": False}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
@@ -176,36 +174,37 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'webexteamssdkdoc'
-
+htmlhelp_basename = "webexteamssdkdoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-     # The paper size ('letterpaper' or 'a4paper').
-     #
-     # 'papersize': 'letterpaper',
-
-     # The font size ('10pt', '11pt' or '12pt').
-     #
-     # 'pointsize': '10pt',
-
-     # Additional stuff for the LaTeX preamble.
-     #
-     # 'preamble': '',
-
-     # Latex figure (float) alignment
-     #
-     # 'figure_align': 'htbp',
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'webexteamssdk.tex', u'webexteamssdk Documentation',
-     u'Chris Lunsford', 'manual'),
+    (
+        master_doc,
+        "webexteamssdk.tex",
+        "webexteamssdk Documentation",
+        "Chris Lunsford",
+        "manual",
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -241,31 +240,34 @@
 # latex_domain_indices = True
 
 
-
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'webexteamssdk', u'webexteamssdk Documentation',
-     [author], 1)
+    (master_doc, "webexteamssdk", "webexteamssdk Documentation", [author], 1)
 ]
 
 # If true, show URL addresses after external links.
 #
 # man_show_urls = False
 
 
-
 # -- Options for Texinfo output -------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'webexteamssdk', u'webexteamssdk Documentation',
-     author, 'webexteamssdk', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "webexteamssdk",
+        "webexteamssdk Documentation",
+        author,
+        "webexteamssdk",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -286,4 +288,4 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/': None}
+intersphinx_mapping = {"https://docs.python.org/": None}

examples/bot-example-flask.py

@@ -68,7 +68,7 @@
 
 
 # Module constants
-CAT_FACTS_URL = 'https://catfact.ninja/fact'
+CAT_FACTS_URL = "https://catfact.ninja/fact"
 
 
 # Initialize the environment
@@ -89,16 +89,16 @@ def get_catfact():
     response = requests.get(CAT_FACTS_URL, verify=False)
     response.raise_for_status()
     json_data = response.json()
-    return json_data['fact']
+    return json_data["fact"]
 
 
 # Core bot functionality
 # Your Webex Teams webhook should point to http://<serverip>:5000/events
-@flask_app.route('/events', methods=['GET', 'POST'])
+@flask_app.route("/events", methods=["GET", "POST"])
 def webex_teams_webhook_events():
     """Processes incoming requests to the '/events' URI."""
-    if request.method == 'GET':
-        return ("""<!DOCTYPE html>
+    if request.method == "GET":
+        return """<!DOCTYPE html>
                    <html lang="en">
                        <head>
                            <meta charset="UTF-8">
@@ -114,8 +114,10 @@ def webex_teams_webhook_events():
                    <blockquote>{}</blockquote>
                    </body>
                    </html>
-                """.format(get_catfact()))
-    elif request.method == 'POST':
+                """.format(
+            get_catfact()
+        )
+    elif request.method == "POST":
         """Respond to inbound webhook JSON HTTP POST from Webex Teams."""
 
         # Get the POST data sent from Webex Teams
@@ -144,7 +146,7 @@ def webex_teams_webhook_events():
         me = api.people.me()
         if message.personId == me.id:
             # Message was sent by me (bot); do not respond.
-            return 'OK'
+            return "OK"
 
         else:
             # Message was sent by someone else; parse message and respond.
@@ -155,9 +157,9 @@ def webex_teams_webhook_events():
                 print("SENDING CAT FACT '{}'".format(cat_fact))
                 # Post the fact to the room where the request was received
                 api.messages.create(room.id, text=cat_fact)
-            return 'OK'
+            return "OK"
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     # Start the Flask web server
-    flask_app.run(host='0.0.0.0', port=5000)
+    flask_app.run(host="0.0.0.0", port=5000)

examples/bot-example-webpy.py

@@ -68,12 +68,12 @@
 
 
 # Module constants
-CAT_FACTS_URL = 'https://catfact.ninja/fact'
+CAT_FACTS_URL = "https://catfact.ninja/fact"
 
 
 # Global variables
 # Your Webex Teams webhook should point to http://<serverip>:8080/events
-urls = ('/events', 'webhook')
+urls = ("/events", "webhook")
 # Create the web application instance
 app = web.application(urls, globals())
 # Create the Webex Teams API connection object
@@ -90,7 +90,7 @@ def get_catfact():
     response = requests.get(CAT_FACTS_URL, verify=False)
     response.raise_for_status()
     json_data = response.json()
-    return json_data['fact']
+    return json_data["fact"]
 
 
 class webhook(object):
@@ -120,7 +120,7 @@ def POST(self):
         me = api.people.me()
         if message.personId == me.id:
             # Message was sent by me (bot); do not respond.
-            return 'OK'
+            return "OK"
         else:
             # Message was sent by someone else; parse message and respond.
             if "/CAT" in message.text:
@@ -130,9 +130,9 @@ def POST(self):
                 print("SENDING CAT FACT '{}'".format(cat_fact))
                 # Post the fact to the room where the request was received
                 api.messages.create(room.id, text=cat_fact)
-        return 'OK'
+        return "OK"
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     # Start the web.py web server
     app.run()