black github action

.github/workflows/black.yml

@@ -0,0 +1,16 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Format
+        uses: psf/black@stable
+        with:
+          options: "--check --diff"
+          src: "./src"
+          use_pyproject: true

.github/workflows/docs.yml

@@ -6,30 +6,30 @@
 # Action artifacts...
 name: Build and Deploy Sphinx Docs to GitHub Pages
 
+
 on:
+  workflow_dispatch:
+  pull_request:
+  release:
+    types:
+      - published
   push:
     branches:
       - main
       - dev
-  release:
-    types:
-      - published
-  pull_request:
 
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
 
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: read
   pages: write
   id-token: write
 
-# Allow one concurrent deployment
+
 concurrency:
   group: "pages"
   cancel-in-progress: true
 
+
 jobs:
   deploy:
     environment:

README.rst

@@ -1,8 +1,16 @@
-=====
+
+.. image:: https://badge.fury.io/py/krank.svg
+   :target: https://badge.fury.io/py/krank
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/psf/black
+
+----
+
+
 Krank
 =====
 
-
 Fetch psychology datasets from remote sources.
 
 .. important::

docs/index.rst

@@ -2,8 +2,12 @@
 .. image:: https://badge.fury.io/py/krank.svg
    :target: https://badge.fury.io/py/krank
 
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/psf/black
+
 ----
 
+
 Krank
 =====
 

pyproject.toml

@@ -40,8 +40,9 @@ Homepage = "https://github.com/remrama/krank"
 
 [project.optional-dependencies]
 dev = [
-  "sphinx",
+  "black",
   "pydata-sphinx-theme",  # Needs to be in requirements.txt also (for docs.yml).
+  "sphinx",
 ]
 
 [tool.setuptools.dynamic]
@@ -59,3 +60,8 @@ krank = [
   "krank/data/lexicons.json",
   "krank/data/tables.json",
 ]
+
+[tool.black]
+line-length = 88
+target-version = ["py312"]
+include = '\.pyi?$'