Use pre-commit CI in favor of GitHub actions (#155)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: codingjoe

.github/CODEOWNERS

@@ -3,4 +3,4 @@
 pyproject.toml @herrbenesch @amureki
 ## GitHub Actions
 .github/workflows/ci.yml @herrbenesch @amureki
-.github/workflows/release.yml @herrbenesch @amureki
+.github/workflows/release.yml @herrbenesch @amureki

.github/dependabot.yml

@@ -1,10 +1,10 @@
 version: 2
 updates:
-- package-ecosystem: pip
-  directory: "/"
-  schedule:
-    interval: daily
-- package-ecosystem: github-actions
-  directory: "/"
-  schedule:
-    interval: daily
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: daily
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily

.github/workflows/ci.yml

@@ -1,13 +1,10 @@
 name: CI
-
 on:
   push:
     branches:
       - main
   pull_request:
-
 jobs:
-
   dist:
     runs-on: ubuntu-latest
     steps:
@@ -21,27 +18,7 @@ jobs:
       - uses: actions/upload-artifact@v5
         with:
           path: dist/*
-
-  lint:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        lint-command:
-          - black --check --diff .
-          - ruff check --output-format=github .
-    steps:
-      - uses: actions/checkout@v5
-      - uses: actions/setup-python@v6
-        with:
-          python-version: "3.x"
-          cache: 'pip'
-          cache-dependency-path: 'pyproject.toml'
-      - run: python -m pip install .[lint]
-      - run: ${{ matrix.lint-command }}
-
   pytest:
-    needs:
-      - lint
     strategy:
       matrix:
         os:
@@ -52,7 +29,7 @@ jobs:
           - "3.12"
           - "3.13"
         django-version:
-          - "4.2"  # LTS
+          - "4.2" # LTS
           - "5.1"
           - "5.2"
         extras:
@@ -73,16 +50,15 @@ jobs:
         options: --entrypoint redis-server
     env:
       REDIS_URL: redis:///0
-
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v5
-    - uses: actions/setup-python@v6
-      with:
-        python-version: ${{ matrix.python-version }}
-    - run: python -m pip install .[${{ matrix.extras }}]
-    - run: python -m pip install django~=${{ matrix.django-version }}.0
-    - run: python -m pytest
-    - uses: codecov/codecov-action@v5
-      with:
-        token: ${{ secrets.CODECOV_TOKEN }}
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python -m pip install .[${{ matrix.extras }}]
+      - run: python -m pip install django~=${{ matrix.django-version }}.0
+      - run: python -m pytest
+      - uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/release.yml

@@ -1,13 +1,10 @@
 name: Release
-
 on:
   release:
     types: [published]
   workflow_dispatch:
-
 permissions:
   id-token: write
-
 jobs:
   release-build:
     runs-on: ubuntu-latest
@@ -22,7 +19,6 @@ jobs:
         with:
           name: release-dists
           path: dist/
-
   pypi-publish:
     runs-on: ubuntu-latest
     needs:

.gitignore

@@ -131,4 +131,4 @@ dmypy.json
 
 # Packaging
 
-dramatiq_crontab/_version.py
+dramatiq_crontab/_version.py

.pre-commit-config.yaml

@@ -0,0 +1,52 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: check-merge-conflict
+      - id: check-ast
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: name-tests-test
+        args: ["--pytest-test-first"]
+        exclude: ^tests\/(testapp\/|manage.py)
+      - id: no-commit-to-branch
+        args: [--branch, main]
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.20.0
+    hooks:
+      - id: pyupgrade
+  - repo: https://github.com/adamchainz/django-upgrade
+    rev: 1.29.0
+    hooks:
+      - id: django-upgrade
+  - repo: https://github.com/hukkin/mdformat
+    rev: 0.7.22
+    hooks:
+      - id: mdformat
+        additional_dependencies:
+          - mdformat-ruff
+          - mdformat-deflist
+          - mdformat-footnote
+          - mdformat-gfm
+          - mdformat-gfm-alerts
+          - mdformat-tables
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.13.3
+    hooks:
+      - id: ruff-check
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
+  - repo: https://github.com/google/yamlfmt
+    rev: v0.19.0
+    hooks:
+      - id: yamlfmt
+# See https://pre-commit.ci/
+ci:
+  autoupdate_schedule: weekly
+  skip:
+    - no-commit-to-branch

README.md

@@ -4,17 +4,17 @@
 
 **Cron style scheduler for asynchronous Dramatiq tasks in Django.**
 
-* setup recurring tasks via crontab syntax
-* lightweight helpers build on robust tools like [Dramatiq][dramatiq] and [APScheduler][apscheduler]
-* [Sentry][sentry] cron monitor support
+- setup recurring tasks via crontab syntax
+- lightweight helpers build on robust tools like [Dramatiq] and [APScheduler]
+- [Sentry] cron monitor support
 
 [![PyPi Version](https://img.shields.io/pypi/v/dramatiq-crontab.svg)](https://pypi.python.org/pypi/dramatiq-crontab/)
 [![Test Coverage](https://codecov.io/gh/voiio/dramatiq-crontab/branch/main/graph/badge.svg)](https://codecov.io/gh/voiio/dramatiq-crontab)
 [![GitHub License](https://img.shields.io/github/license/voiio/dramatiq-crontab)](https://raw.githubusercontent.com/voiio/dramatiq-crontab/master/LICENSE)
 
 ## Setup
 
-You need to have [Dramatiq][dramatiq] installed and setup properly.
+You need to have [Dramatiq] installed and setup properly.
 
 ```ShellSession
 python3 -m pip install dramatiq-crontab
@@ -27,7 +27,7 @@ Add `dramatiq_crontab` to your `INSTALLED_APPS` in `settings.py`:
 ```python
 # settings.py
 INSTALLED_APPS = [
-    'dramatiq_crontab',
+    "dramatiq_crontab",
     # ...
 ]
 ```
@@ -90,7 +90,7 @@ be at 12:00:45.
 
 ### Sentry Cron Monitors
 
-If you use [Sentry][sentry] you can add cron monitors to your tasks.
+If you use [Sentry] you can add cron monitors to your tasks.
 The monitor's slug will be the actor's name. Like `my_task` in the example above.
 
 ### The crontab command
@@ -109,6 +109,6 @@ options:
   --no-heartbeat        Don't start the heartbeat actor.
 ```
 
-[dramatiq]: https://dramatiq.io/
 [apscheduler]: https://apscheduler.readthedocs.io/en/stable/
+[dramatiq]: https://dramatiq.io/
 [sentry]: https://docs.sentry.io/product/crons/

pyproject.toml

@@ -51,11 +51,6 @@ test = [
 sentry = ["sentry-sdk"]
 redis = ["redis"]
 
-lint = [
-  "black==25.9.0",
-  "ruff==0.14.3",
-]
-
 [project.urls]
 Project-URL = "https://github.com/voiio/dramatiq-crontab"
 Changelog = "https://github.com/voiio/dramatiq-crontab/releases"

tests/testapp/settings.py

@@ -24,9 +24,7 @@
 # See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = (
-    "django-insecure--@w!1qsi6azo&=a**ia3b43k^@q9aor_rqyu=1i5yd-zinpo)0"  # noqa: S105
-)
+SECRET_KEY = "django-insecure--@w!1qsi6azo&=a**ia3b43k^@q9aor_rqyu=1i5yd-zinpo)0"  # noqa: S105
 
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True