Enforce Black, closes #119

Author: simonw

.github/workflows/test.yml

@@ -27,4 +27,6 @@ jobs:
     - name: Run tests
       run: |
         pytest
+    - name: Check formatting
+      run: black . --check
 

django_sql_dashboard/migrations/0004_add_description_help_text.py

@@ -6,13 +6,15 @@
 class Migration(migrations.Migration):
 
     dependencies = [
-        ('django_sql_dashboard', '0003_update_metadata'),
+        ("django_sql_dashboard", "0003_update_metadata"),
     ]
 
     operations = [
         migrations.AlterField(
-            model_name='dashboard',
-            name='description',
-            field=models.TextField(blank=True, help_text='Optional description (Markdown allowed)'),
+            model_name="dashboard",
+            name="description",
+            field=models.TextField(
+                blank=True, help_text="Optional description (Markdown allowed)"
+            ),
         ),
     ]

docs/contributing.md

@@ -29,7 +29,7 @@ To generate migrations for model changes:
 
 ## Code style
 
-This library uses [Black](https://github.com/psf/black) for code formatting.
+This library uses [Black](https://github.com/psf/black) for code formatting. The correct version of Black will be installed by `pip install -e '.[test]'` - you can run `black .` in the root directory to apply those formatting rules.
 
 ## Documentation
 

setup.py

@@ -40,6 +40,7 @@ def get_long_description():
     install_requires=["Django>=3.0", "markdown", "bleach"],
     extras_require={
         "test": [
+            "black==21.5b2",
             "psycopg2",
             "pytest",
             "pytest-django==4.2.0",