Apply black formatting

Use black to autoformat the code, so when making changes you don't have
to worry about white space etc, and can just use black.

Integrate into tox and the ci lint workflow for validation

Author: jogo

.github/workflows/ci.yml

@@ -24,8 +24,8 @@ jobs:
     - name: Tests
       run: |
         pip install tox
-        tox
+        tox -epy3
     - name: Lint
       run: |
         pip install tox
-        tox -eisort
+        tox -eisort,black

docs/conf.py

@@ -29,42 +29,42 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.doctest',
-    'sphinx.ext.todo',
-    'sphinx.ext.coverage',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.ifconfig',
-    'sphinx.ext.viewcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.ifconfig",
+    "sphinx.ext.viewcode",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'slackminion'
-copyright = u'2020 Pinterest, Inc.'
-author = u'Pinterest, Inc.'
+project = "slackminion"
+copyright = "2020 Pinterest, Inc."
+author = "Pinterest, Inc."
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'0'
+version = "0"
 # The full version, including alpha/beta/rc tags.
-release = u'0'
+release = "0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -82,7 +82,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -100,7 +100,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -144,7 +144,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -209,20 +209,17 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'slackminiondoc'
+htmlhelp_basename = "slackminiondoc"
 
 # -- 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',
 }
@@ -231,8 +228,13 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'slackminion.tex', u'slackminion Documentation',
-     u'Nick King', 'manual'),
+    (
+        master_doc,
+        "slackminion.tex",
+        "slackminion Documentation",
+        "Nick King",
+        "manual",
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -260,10 +262,7 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, 'slackminion', u'slackminion Documentation',
-     [author], 1)
-]
+man_pages = [(master_doc, "slackminion", "slackminion Documentation", [author], 1)]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -275,9 +274,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'slackminion', u'slackminion Documentation',
-     author, 'slackminion', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "slackminion",
+        "slackminion Documentation",
+        author,
+        "slackminion",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.

setup.py

@@ -3,38 +3,38 @@
 from slackminion.plugins.core import version
 
 setup(
-        name='slackminion',
-        version=version,
-        packages=find_packages(exclude=['test_plugins']),
-        url='https://github.com/pinterest/slackminion',
-        license='MIT',
-        author='Pinterest, Inc.',
-        author_email='',
-        description='A python bot framework for slack',
-        package_data={'slackminion': ['templates/*']},
-        python_requires='>=3.7',
-        install_requires=[
-            'Flask>=1.1.1',
-            'itsdangerous>=0.24',
-            'Jinja2>=2.10',
-            'MarkupSafe>=0.23',
-            'PyYAML>=4.2b',
-            'requests >=2.11, <3.0a0',
-            'slack_sdk==3.13.0',
-            'websocket-client >=0.35, <0.55.0',
-            'Werkzeug>=0.10.4',
-            'aiohttp==3.7.4.post0',
-        ],
-        entry_points={
-            'console_scripts': [
-                'slackminion = slackminion.__main__:main',
-            ]
-        },
-        classifiers=[
-            "Programming Language :: Python",
-            "License :: OSI Approved :: MIT License",
-            "Operating System :: OS Independent",
-            "Development Status :: 2 - Pre-Alpha",
-            "Topic :: Communications :: Chat",
+    name="slackminion",
+    version=version,
+    packages=find_packages(exclude=["test_plugins"]),
+    url="https://github.com/pinterest/slackminion",
+    license="MIT",
+    author="Pinterest, Inc.",
+    author_email="",
+    description="A python bot framework for slack",
+    package_data={"slackminion": ["templates/*"]},
+    python_requires=">=3.7",
+    install_requires=[
+        "Flask>=1.1.1",
+        "itsdangerous>=0.24",
+        "Jinja2>=2.10",
+        "MarkupSafe>=0.23",
+        "PyYAML>=4.2b",
+        "requests >=2.11, <3.0a0",
+        "slack_sdk==3.13.0",
+        "websocket-client >=0.35, <0.55.0",
+        "Werkzeug>=0.10.4",
+        "aiohttp==3.7.4.post0",
+    ],
+    entry_points={
+        "console_scripts": [
+            "slackminion = slackminion.__main__:main",
         ]
+    },
+    classifiers=[
+        "Programming Language :: Python",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Development Status :: 2 - Pre-Alpha",
+        "Topic :: Communications :: Chat",
+    ],
 )

slackminion/__main__.py

@@ -14,16 +14,22 @@ def sigterm_handler(signum, frame):
         bot.runnable = False
 
     p = argparse.ArgumentParser()
-    p.add_argument('--config', action='store', default='config.yaml',
-                   help='Specify a config file (default: config.yaml)')
-    p.add_argument('--test', action='store_true', help='Load plugins and exit')
+    p.add_argument(
+        "--config",
+        action="store",
+        default="config.yaml",
+        help="Specify a config file (default: config.yaml)",
+    )
+    p.add_argument("--test", action="store_true", help="Load plugins and exit")
     args = p.parse_args()
 
-    with open(args.config, 'rb') as f:
+    with open(args.config, "rb") as f:
         config = yaml.load(f, Loader=yaml.SafeLoader)
 
-    level = logging.DEBUG if config['debug'] else logging.INFO
-    logging.basicConfig(level=level, format='%(asctime)s %(name)s %(levelname)s: %(message)s')
+    level = logging.DEBUG if config["debug"] else logging.INFO
+    logging.basicConfig(
+        level=level, format="%(asctime)s %(name)s %(levelname)s: %(message)s"
+    )
 
     bot = Bot(config, args.test)
     bot.start()
@@ -39,25 +45,33 @@ def sigterm_handler(signum, frame):
         output.append("Plugins Loaded")
         for p in bot.plugin_manager.plugins:
             context = {
-                'name': type(p).__name__,
-                'version': '-'.join([p._version, p._commit]),
-                'load_time': metrics['load_times'][type(p).__name__]
+                "name": type(p).__name__,
+                "version": "-".join([p._version, p._commit]),
+                "load_time": metrics["load_times"][type(p).__name__],
             }
-            output.append("{name:<30} {version:<20} {load_time:>7.03f} ms".format(**context))
-        if len(metrics['plugins_failed']) > 0:
+            output.append(
+                "{name:<30} {version:<20} {load_time:>7.03f} ms".format(**context)
+            )
+        if len(metrics["plugins_failed"]) > 0:
             output.append("")
             output.append("Plugins failed to load")
-            for p in metrics['plugins_failed']:
+            for p in metrics["plugins_failed"]:
                 output.append(p)
         output.append("")
-        output.append("Bot startup time: %.03f ms" % bot.metrics['startup_time'])
-        output.append("Plugins: %d total, %d loaded, %d failed" % (
-            metrics['plugins_total'], metrics['plugins_loaded'], len(metrics['plugins_failed'])))
-        if metrics['plugins_total'] != metrics['plugins_loaded']:
+        output.append("Bot startup time: %.03f ms" % bot.metrics["startup_time"])
+        output.append(
+            "Plugins: %d total, %d loaded, %d failed"
+            % (
+                metrics["plugins_total"],
+                metrics["plugins_loaded"],
+                len(metrics["plugins_failed"]),
+            )
+        )
+        if metrics["plugins_total"] != metrics["plugins_loaded"]:
             output.append("")
             output.append("=== Bot Failed Startup Tests ===")
             test_passed = False
-        logging.getLogger().info('\n'.join(output))
+        logging.getLogger().info("\n".join(output))
 
         if not test_passed:
             sys.exit(1)