labull-framework

一个可插拔的 Django app（import 名 labull_framework），提供两件事：

• Authing / OIDC 登录：自带的认证后端，只用标准库 + PyJWT，不依赖任何 OIDC 客户端包。
• magic block：一个 uuid + 一整个文件包就是一个功能块，住在数据库里、在沙箱 iframe 里渲染， 不重新编译、不重启；块可以带自己的后端 Python（backend_open.py）。

另附一个可选的 数据模型页（LABULL_SCHEMA_CANVAS=on 才开）。

安装

pip install labull-framework

接进一个 Django 项目

settings.py 里三件事：

from labull_framework.env import load_env_file
load_env_file(BASE_DIR / '.env')            # ① 第一行：读 .env

AUTH_USER_MODEL = 'labull_framework.User'   # ② 第一次 migrate 之前就要设好

from labull_framework.settings import apply_platform_settings
apply_platform_settings(globals())          # ③ 最后一行：把平台的设置补进来

urls.py 里一行：

from labull_framework.urls import urlpatterns as labull_urls
urlpatterns = [*labull_urls, path('admin/', admin.site.urls)]

wsgi.py 里一行（别漏，重设管理员名单与启动体检都在这里）：

from labull_framework.magic_block.health import startup_once
startup_once()

然后：

python manage.py migrate
python manage.py runserver

.env 最少要这几项：

DATABASE_URL=postgres://postgres:postgres@localhost:5432/app
SSO_ISSUER=https://<你的域名>.authing.cn/oidc
SSO_CLIENT_ID=<Authing 应用 ID>
SSO_CLIENT_SECRET=<Authing 应用密钥>
SSO_REDIRECT_URI=http://localhost:8000/auth/callback
SSO_WEB_ORIGIN=http://localhost:5173
CORS_ORIGIN=http://localhost:5173

sqlite:///db.sqlite3 也认，本地开发不必装数据库。

magic block

一个块 = 一个 uuid + 一整个文件包：

我的块/
├─ index.open.html        入口（必备）
├─ magic-block.open.yaml  清单（必备）：id / module / name / brief 四个键
├─ 任意 js / css
└─ backend_open.py        块自己的后端（可选）

块后端与项目里别的 Python 代码没有区别：

from labull_framework.magic_block.sdk import MagicBackendAPI, errors

class Order:
    @MagicBackendAPI()                       # 省略 permission = 任何登录用户都能调
    def list(self, ctx, params):
        from modules.orders.models import Order
        return [{'id': o.id} for o in Order.objects.all()[:20]]

    @MagicBackendAPI(permission='labull_framework.edit_blocks')
    def close(self, ctx, params):
        if not params.get('id'):
            raise errors.BadRequest('要给我一个 id')
        return {'ok': True}

配置：环境变量里带 BLOCK_ 前缀的才会进 ctx.config（BLOCK_OCR_KEY=a ⇒ ctx.config['OCR_KEY']）。

运行环境

• Python ≥ 3.10
• Django ≥ 4.2（在 6.1 上验证过）
• PyJWT（带 crypto 后端）

License

MIT