Scaffold out plugin system using pluggy (#185)

Author: joshuadavidthomas

CHANGELOG.md

@@ -18,6 +18,10 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 
 ## [Unreleased]
 
+### Added
+
+- Added plugin system infrastructure using `pluggy`.
+
 ## [0.14.2]
 
 ### Changed

pyproject.toml

@@ -55,7 +55,11 @@ classifiers = [
   "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: Implementation :: CPython"
 ]
-dependencies = ["cachetools>=5.5.0", "django>=4.2"]
+dependencies = [
+  "cachetools>=5.5.0",
+  "django>=4.2",
+  "pluggy>=1.5.0"
+]
 description = "High-flying components for perfectionists with deadlines"
 dynamic = ["version"]
 keywords = []
@@ -119,6 +123,7 @@ fail_under = 98
 [tool.coverage.run]
 omit = [
   "src/django_bird/migrations/*",
+  "src/django_bird/plugins/*",  # TODO: remove when plugin hooks implemented
   "src/django_bird/_typing.py",
   "src/django_bird/views.py",  # TODO: remove when not empty
   "tests/*"

src/django_bird/__init__.py

@@ -1,3 +1,7 @@
 from __future__ import annotations
 
+from pluggy import HookimplMarker
+
 __version__ = "0.14.2"
+
+hookimpl = HookimplMarker("django_bird")

src/django_bird/plugins/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from .manager import pm
+
+__all__ = [
+    "pm",
+]

src/django_bird/plugins/hookspecs.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from pluggy import HookspecMarker
+
+hookspec = HookspecMarker("django_bird")

src/django_bird/plugins/manager.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+import importlib
+
+import pluggy
+
+from django_bird.plugins import hookspecs
+
+pm = pluggy.PluginManager("django_bird")
+pm.add_hookspecs(hookspecs)
+
+DEFAULT_PLUGINS: list[str] = []
+
+for plugin in DEFAULT_PLUGINS:
+    mod = importlib.import_module(plugin)
+    pm.register(mod, plugin)