Launchbox Helper for Django

为您的Django应用提供与Launchbox集成的插件。

功能

该插件目前提供以下功能

• 用于简化配置Launchbox提供的资源（如数据库、缓存和存储桶）设置的辅助类
• 用于查询Launchbox插件提供的身份服务的类
• 一个API，用于从您的应用程序获取信息，以便Launchbox可以在其管理仪表板中显示或更改该信息

计划中的功能

• 与其他Launchbox插件类型集成 - 身份验证和SSL证书管理

安装

以下步骤假设您已经将 launch.yaml 文件添加到您的应用程序中。有关更多信息，请访问Launchbox 文档。

1. 将 django-launchbox 添加到您项目的需求中并安装它。
2. 将 "launchbox" 添加到您的 INSTALLED_APPS 设置中，如下所示

   INSTALLED_APPS = [
       "launchbox",
       ...
   ]
   

3. 更新您的 Django 设置以使用 Launchbox 提供的数据库

   from launchbox import LBResources
   
   DATABASES = {
       # "db" is the resource identifier specified in your launch.yaml file
       "default": LBResources().settings("db")
   }
   

   • 如果您在 launch.yaml 文件中配置了缓存或存储桶，请更新这些设置

     from launchbox import LBResources
     
     CACHES = {
         # "cache" is the resource identifier specified in your launch.yaml file
         "default": LBResources().settings("cache")
     }
     
     # AWS_STORAGE_BUCKET_NAME is a django-storages setting
     # "storage" is the resource identifier specified in your launch.yaml file
     AWS_STORAGE_BUCKET_NAME = LBResources().settings("storage") 
     

4. 如果您想管理 Launchbox 仪表板中的用户，请添加 LB_USER_ATTRIBUTES 设置以指定您想要记录和验证的用户模型字段和属性

   LB_USER_ATTRIBUTES = [
       "first_name",
       "last_name",
       "middle_initial",
       "display_name",
       "email",
       "admin_access",
       "is_active",
       "is_editor",
       "is_moderator",
       "is_owner",
       "is_superuser",
   ]
   

   然后，将 Launchbox 桥接 API URL 添加到您项目的 urls.py 中的 urlpatterns

   # Launchbox Service Bridge API
   path("bridge/", include("launchbox.api.urls")),
   

使用 Launchbox 插件

身份提供者

使用 LBIdentity 类查询 Launchbox 插件提供的身份服务。对于下面提供的所有示例，请确保您已经通过以下方式导入该类：

from launchbox import LBIdentity

您需要知道一个插件的 plugin_id（Launchbox 内部的标识符）才能与之交互。

获取特定用户

当您知道用户在身份数据库中的确切用户 ID 时，使用 user.get() 方法获取用户详情

user_details = LBIdentity("plugin_id").user.get("user_id")

搜索部分匹配的用户

当您不确定用户的用户 ID 时，使用 user.search() 方法搜索用户

user_details = LBIdentity("plugin_id").user.search("user_id")

获取用户所属的组

对于可以将用户放入组的身份提供者，您可以使用 user.groups() 方法获取用户所属的组列表

user_groups = LBIdentity("plugin_id").user.groups("user_id")

获取组详情

要获取组的详细信息，请使用 group.get() 方法

group_details = LBIdentity("plugin_id").group.get("group_id")