Add black code linter

Author: codingjoe

.github/workflows/ci.yml

@@ -1,9 +1,21 @@
 name: CI
 
-on: [pull_request]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
 
 jobs:
 
+  black:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-python@v1
+      - uses: actions/checkout@v2
+      - run: python -m pip install black
+      - run: black --check --diff .
+
   docs:
     runs-on: ubuntu-latest
     steps:
@@ -64,6 +76,8 @@ jobs:
         CODECOV_TOKEN: ${{secrets.CODECOV_TOKEN}}
 
   extras:
+    needs:
+      - dist
     runs-on: ubuntu-latest
     strategy:
       matrix:

.github/workflows/release.yml

@@ -1,20 +1,21 @@
-name: PyPi Release
+name: Release
 
-on: [release]
+on:
+  release:
+    types: [published]
 
 jobs:
-  build:
-
+  PyPI:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
-    - uses: actions/setup-python@v1
-    - name: Install Python dependencies
-      run: python -m pip install --upgrade pip setuptools wheel twine
-    - name: Build dist packages
-      run: python setup.py sdist bdist_wheel
-    - name: Upload packages
-      run: python -m twine upload dist/*
-      env:
-        TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}
+      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v2
+      - name: Install Python dependencies
+        run: python -m pip install --upgrade pip setuptools wheel twine
+      - name: Build dist packages
+        run: python setup.py sdist bdist_wheel
+      - name: Upload packages
+        run: python -m twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}

docs/conf.py

@@ -6,74 +6,82 @@
 import django
 
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.testapp.settings")
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 django.setup()
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.inheritance_diagram',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.githubpages',
-    'sphinx.ext.linkcode',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.inheritance_diagram",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.linkcode",
 ]
 
 try:
     import sphinxcontrib.spelling  # noqa
 except ImportError:
     pass
 else:
-    extensions.append('sphinxcontrib.spelling')
+    extensions.append("sphinxcontrib.spelling")
 
 
 def linkcode_resolve(domain, info):
     """Link source code to GitHub."""
-    project = 'joeflow'
-    github_user = 'codingjoe'
-    head = 'master'
+    project = "joeflow"
+    github_user = "codingjoe"
+    head = "master"
 
-    if domain != 'py' or not info['module']:
+    if domain != "py" or not info["module"]:
         return None
-    filename = info['module'].replace('.', '/')
-    mod = importlib.import_module(info['module'])
+    filename = info["module"].replace(".", "/")
+    mod = importlib.import_module(info["module"])
     basename = os.path.splitext(mod.__file__)[0]
-    if basename.endswith('__init__'):
-        filename += '/__init__'
+    if basename.endswith("__init__"):
+        filename += "/__init__"
     item = mod
-    lineno = ''
+    lineno = ""
 
-    for piece in info['fullname'].split('.'):
+    for piece in info["fullname"].split("."):
         try:
             item = getattr(item, piece)
         except AttributeError:
             pass
         try:
             lines, first_line = inspect.getsourcelines(item)
-            lineno = '#L%d-L%s' % (first_line, first_line + len(lines) - 1)
+            lineno = "#L%d-L%s" % (first_line, first_line + len(lines) - 1)
         except (TypeError, IOError):
             pass
-    return ("https://github.com/%s/%s/blob/%s/%s.py%s" %
-            (github_user, project, head, filename, lineno))
+    return "https://github.com/%s/%s/blob/%s/%s.py%s" % (
+        github_user,
+        project,
+        head,
+        filename,
+        lineno,
+    )
 
 
 # The master toctree document.
-master_doc = 'index'
-project = 'Joeflow'
+master_doc = "index"
+project = "Joeflow"
 
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', None),
-    'django': ('https://docs.djangoproject.com/en/stable/',
-               'https://docs.djangoproject.com/en/stable/_objects/'),
-    'celery': ('https://celery.readthedocs.io/en/stable/', None),
-    'graphviz': ('https://graphviz.readthedocs.io/en/stable/', None),
+    "python": ("https://docs.python.org/3", None),
+    "django": (
+        "https://docs.djangoproject.com/en/stable/",
+        "https://docs.djangoproject.com/en/stable/_objects/",
+    ),
+    "celery": ("https://celery.readthedocs.io/en/stable/", None),
+    "graphviz": ("https://graphviz.readthedocs.io/en/stable/", None),
 }
 
-spelling_word_list_filename = 'spelling_wordlist.txt'
+spelling_word_list_filename = "spelling_wordlist.txt"
 spelling_show_suggestions = True
 
-graphviz_output_format = 'svg'
+graphviz_output_format = "svg"
 
-inheritance_graph_attrs = dict(rankdir="TB", size='"6.0, 8.0"',
-                               fontsize=14, ratio='compress')
+inheritance_graph_attrs = dict(
+    rankdir="TB", size='"6.0, 8.0"', fontsize=14, ratio="compress"
+)

joeflow/__init__.py

@@ -1,2 +1,2 @@
 """The lean workflow automation framework for machines with heart."""
-default_app_config = 'joeflow.apps.JoeflowConfig'
+default_app_config = "joeflow.apps.JoeflowConfig"

joeflow/admin.py

@@ -6,121 +6,125 @@
 from . import models
 from .contrib.reversion import VersionAdmin
 
-__all__ = (
-    'ProcessAdmin',
-)
+__all__ = ("ProcessAdmin",)
 
 
 def rerun(modeladmin, request, queryset):
     succeeded = queryset.succeeded().count()
     if succeeded:
-        messages.warning(request, "Only failed tasks can be retried. %s tasks have been skipped" % succeeded)
+        messages.warning(
+            request,
+            "Only failed tasks can be retried. %s tasks have been skipped" % succeeded,
+        )
     counter = 0
     for obj in queryset.not_succeeded().iterator():
         obj.enqueue()
         counter += 1
     messages.success(request, "%s tasks have been successfully queued" % counter)
 
 
-rerun.short_description = t('Rerun selected tasks')
-rerun.allowed_permissions = ('rerun',)
+rerun.short_description = t("Rerun selected tasks")
+rerun.allowed_permissions = ("rerun",)
 
 
 def cancel(modeladmin, request, queryset):
     not_scheduled = queryset.not_scheduled().count()
     if not_scheduled:
-        messages.warning(request, "Only scheduled tasks can be canceled. %s tasks have been skipped" % not_scheduled)
+        messages.warning(
+            request,
+            "Only scheduled tasks can be canceled. %s tasks have been skipped"
+            % not_scheduled,
+        )
     queryset.scheduled().cancel(request.user)
     messages.success(request, "Tasks have been successfully canceled")
 
 
-cancel.short_description = t('Cancel selected tasks')
-cancel.allowed_permissions = ('cancel',)
+cancel.short_description = t("Cancel selected tasks")
+cancel.allowed_permissions = ("cancel",)
 
 
 @admin.register(models.Task)
 class TaskAdmin(VersionAdmin):
-
     def has_rerun_permission(self, request):
         opts = self.opts
-        codename = get_permission_codename('rerun', opts)
-        return request.user.has_perm('%s.%s' % (opts.app_label, codename))
+        codename = get_permission_codename("rerun", opts)
+        return request.user.has_perm("%s.%s" % (opts.app_label, codename))
 
     def has_cancel_permission(self, request):
         opts = self.opts
-        codename = get_permission_codename('cancel', opts)
-        return request.user.has_perm('%s.%s' % (opts.app_label, codename))
+        codename = get_permission_codename("cancel", opts)
+        return request.user.has_perm("%s.%s" % (opts.app_label, codename))
 
     def pretty_stacktrace(self, obj):
         return format_html('<pre class="readonly collapse">{}<pre>', obj.stacktrace)
 
-    pretty_stacktrace.short_description = t('Traceback')
+    pretty_stacktrace.short_description = t("Traceback")
 
     def child_tasks(self, obj):
         return ", ".join(str(task) for task in obj.child_task_set.all().iterator())
 
-    child_tasks.short_description = t('Child tasks')
+    child_tasks.short_description = t("Child tasks")
 
     actions = (rerun, cancel)
 
     list_display = (
-        'name',
-        'status',
-        'type',
-        'content_type',
-        'completed',
-        'modified',
-        'created',
+        "name",
+        "status",
+        "type",
+        "content_type",
+        "completed",
+        "modified",
+        "created",
     )
 
     readonly_fields = (
-        'process',
-        'name',
-        'type',
-        'parent_task_set',
-        'child_tasks',
-        'completed',
-        'created',
-        'modified',
-        'exception',
-        'pretty_stacktrace',
+        "process",
+        "name",
+        "type",
+        "parent_task_set",
+        "child_tasks",
+        "completed",
+        "created",
+        "modified",
+        "exception",
+        "pretty_stacktrace",
     )
 
     list_filter = (
-        'status',
-        'type',
-        'content_type',
-        'completed',
-        'created',
+        "status",
+        "type",
+        "content_type",
+        "completed",
+        "created",
     )
 
     fieldsets = (
-        (None, {
-            'fields': (
-                'process',
-                'name',
-                'parent_task_set',
-                'child_tasks',
-                'completed',
-                'modified',
-                'created',
-                'exception'
-            ),
-        }),
-        (t('Traceback'), {
-            'classes': ('collapse',),
-            'fields': ('pretty_stacktrace',),
-        }),
+        (
+            None,
+            {
+                "fields": (
+                    "process",
+                    "name",
+                    "parent_task_set",
+                    "child_tasks",
+                    "completed",
+                    "modified",
+                    "created",
+                    "exception",
+                ),
+            },
+        ),
+        (t("Traceback"), {"classes": ("collapse",), "fields": ("pretty_stacktrace",)}),
     )
 
 
 class ProcessAdmin(VersionAdmin):
     readonly_fields = (
-        'modified',
-        'created',
+        "modified",
+        "created",
     )
 
     list_filter = (
-        'modified',
-        'created',
+        "modified",
+        "created",
     )

joeflow/apps.py

@@ -3,9 +3,10 @@
 
 
 class JoeflowConfig(AppConfig):
-    name = 'joeflow'
-    verbose_name = t('Joeflow')
+    name = "joeflow"
+    verbose_name = t("Joeflow")
 
     def ready(self):
         from .contrib.reversion import register_processes
+
         register_processes()