django-bird

为有截止日期的完美主义者提供高性能组件。

[!注意] 这是一个实验性的、预alpha版本，旨在采用不同的方法定义Django模板中的组件。目前还不适用于生产使用。

需求

• Python 3.10, 3.11, 3.12, 3.13
• Django 4.2, 5.0, 5.1

安装

1. 从PyPI安装软件包

   python -m pip install django-bird
   
   # or if you like the new hotness
   
   uv add django-bird
   uv sync
   

2. 将应用添加到Django项目的INSTALLED_APPS

   INSTALLED_APPS = [
       ...,
       "django_bird",
       ...,
   ]
   

3. django-bird 需要在您的 settings.TEMPLATES 中配置两个设置才能正常工作

   • django_bird.templatetags.django_bird 位于 builtins
   • django_bird.loader.BirdLoader 在 loaders 的最内层列表中，在 django.template.loaders.filesystem.Loader 和 django.template.loaders.app_directories.Loader 之前

   默认情况下，这些应该会自动为您配置。如果您想禁用此行为并自行设置，则需要设置 DJANGO_BIRD["ENABLE_AUTO_CONFIG"] = False。

   # settings.py
   from pathlib import Path
   
   
   DJANGO_BIRD = {
       "ENABLE_AUTO_CONFIG": False,
   }
   
   TEMPLATES = [
       {
           "BACKEND": "django.template.backends.django.DjangoTemplates",
           "DIRS": [
               Path(__file__).parent / "templates",
           ],
           "OPTIONS": {
               "builtins": [
                   "django_bird.templatetags.django_bird",
               ],
               "loaders": [
                   (
                       "django.template.loaders.cached.Loader",
                       [
                           "django_bird.loader.BirdLoader",
                           "django.template.loaders.filesystem.Loader",
                           "django.template.loaders.app_directories.Loader",
                       ],
                   ),
               ],
           },
       }
   ]
   

入门指南

即将推出...

文档

请参阅文档获取更多信息。

许可证

django-bird 采用 MIT 许可证。有关更多信息，请参阅LICENSE 文件。