Add ready plugin hook and refactor library init to internal plugin (#198)

* Add `ready` plugin hook and refactor library init to internal plugin

* update changelog

Author: joshuadavidthomas

CHANGELOG.md

@@ -18,6 +18,14 @@ and this project attempts to adhere to [Semantic Versioning](https://semver.org/
 
 ## [Unreleased]
 
+### Added
+
+- Added new plugin hook `ready` for handling application initialization during Django's application ready phase.
+
+### Changed
+
+- **Internal**: Refactored application initialization to use internal plugin instead of direct calls in `AppConfig.ready()`.
+
 ## [0.16.0]
 
 🚨 This release contains some breaking changes. See the Changed section for more information. 🚨

docs/plugins.md

@@ -20,6 +20,14 @@ django-bird uses a plugin system based on [pluggy](https://pluggy.readthedocs.io
 ```
 ````
 
+````{py:function} ready(app_settings: django_bird.conf.AppSettings) -> None
+:canonical: django_bird.plugins.hookspecs.ready
+
+```{autodoc2-docstring} django_bird.plugins.hookspecs.ready
+:parser: myst
+```
+````
+
 ````{py:function} register_asset_types(register_type: collections.abc.Callable[[django_bird.staticfiles.AssetType], None]) -> None
 :canonical: django_bird.plugins.hookspecs.register_asset_types
 

src/django_bird/apps.py

@@ -15,11 +15,8 @@ class DjangoBirdAppConfig(AppConfig):
 
     @override
     def ready(self):
-        from django_bird.components import components
         from django_bird.conf import app_settings
         from django_bird.plugins import pm
-        from django_bird.staticfiles import asset_types
 
-        app_settings.autoconfigure()
-        pm.hook.register_asset_types(register_type=asset_types.register_type)
-        components.discover_components()
+        for init_handler in pm.hook.ready(app_settings=app_settings):
+            init_handler()

src/django_bird/conf.py

@@ -10,13 +10,24 @@
 import django.template
 from django.conf import settings
 
+from django_bird import hookimpl
+
 from ._typing import override
 from .utils import unique_ordered
 
-DJANGO_BIRD_SETTINGS_NAME = "DJANGO_BIRD"
 
-DJANGO_BIRD_BUILTINS = "django_bird.templatetags.django_bird"
-DJANGO_BIRD_FINDER = "django_bird.staticfiles.BirdAssetFinder"
+@hookimpl
+def ready(app_settings: AppSettings):
+    from .components import components
+    from .plugins import pm
+    from .staticfiles import asset_types
+
+    app_settings.autoconfigure()
+    pm.hook.register_asset_types(register_type=asset_types.register_type)
+    components.discover_components()
+
+
+DJANGO_BIRD_SETTINGS_NAME = "DJANGO_BIRD"
 
 
 @dataclass
@@ -44,6 +55,10 @@ def get_component_directory_names(self):
         return unique_ordered([*self.COMPONENT_DIRS, "bird"])
 
 
+DJANGO_BIRD_BUILTINS = "django_bird.templatetags.django_bird"
+DJANGO_BIRD_FINDER = "django_bird.staticfiles.BirdAssetFinder"
+
+
 @final
 class AutoConfigurator:
     def __init__(self, app_settings: AppSettings) -> None:

src/django_bird/plugins/hookspecs.py

@@ -8,6 +8,7 @@
 from pluggy import HookspecMarker
 
 if TYPE_CHECKING:
+    from django_bird.conf import AppSettings
     from django_bird.staticfiles import Asset
     from django_bird.staticfiles import AssetType
 
@@ -37,6 +38,16 @@ def get_template_directories() -> list[Path]:
     """
 
 
+@hookspec
+def ready(app_settings: AppSettings) -> None:
+    """Called when the django-bird application is ready.
+
+    This hook is called during Django's application ready phase,
+    allowing plugins to perform necessary setup like configuring
+    settings, registering features, or any other initialization tasks.
+    """
+
+
 @hookspec
 def register_asset_types(register_type: Callable[[AssetType], None]) -> None:
     """Register a new type of asset.

src/django_bird/plugins/manager.py

@@ -12,6 +12,7 @@
 pm.load_setuptools_entrypoints("django_bird")
 
 DEFAULT_PLUGINS: list[str] = [
+    "django_bird.conf",
     "django_bird.staticfiles",
     "django_bird.templates",
 ]