django_yunohost_integration

Python包django_yunohost_integration，包含将Django项目集成为YunoHost包的帮助工具。

此包的示例用法在此

• https://github.com/YunoHost-Apps/django_example_ynh

欢迎提交pull请求 ;)

以下项目使用了django_yunohost_integration

• https://github.com/YunoHost-Apps/pyinventory_ynh
• https://github.com/YunoHost-Apps/django-for-runners_ynh
• https://github.com/YunoHost-Apps/django-fmd_ynh

功能

• SSOwat集成（见下文）
• 为scripts/install创建第一个超级用户的帮助工具
• 使用本地生成的YunoHost包安装（称为local_test）运行Django开发服务器
• 运行针对local_test "安装"的pytest的辅助工具

SSO身份验证

SSOwat完全支持

• 第一个用户（$YNH_APP_ARG_ADMIN）将被创建为Django的超级用户
• 所有新用户都将被创建为普通用户
• 完全支持通过SSO登录
• 用户电子邮件、姓名和姓氏将从SSO数据更新

用法

在install/upgrade中创建/更新第一个用户，例如

./manage.py create_superuser --username="$admin" --email="$admin_mail"

创建/更新Django超级用户并设置一个不可用的密码。密码不是必需的，因为身份验证是通过SSOwat完成的 ;)

settings.py中的主要部分

from pathlib import Path as __Path

from django_yunohost_integration.base_settings import *  # noqa
from django_yunohost_integration.secret_key import get_or_create_secret as __get_or_create_secret


DEBUG = bool(int('__DEBUG_ENABLED__'))  # Set via config_panel.toml

# -----------------------------------------------------------------------------

DATA_DIR_PATH = __Path('__DATA_DIR__')  # /home/yunohost.app/$app
assert DATA_DIR_PATH.is_dir(), f'Directory not exists: {DATA_DIR_PATH}'

INSTALL_DIR_PATH = __Path('__INSTALL_DIR__')  # /var/www/$app
assert INSTALL_DIR_PATH.is_dir(), f'Directory not exists: {INSTALL_DIR_PATH}'

LOG_FILE = __Path('__LOG_FILE__')  # /var/log/$app/$app.log
assert LOG_FILE.is_file(), f'File not exists: {LOG_FILE}'

PATH_URL = '__PATH_URL__'  # $YNH_APP_ARG_PATH
PATH_URL = PATH_URL.strip('/')

# -----------------------------------------------------------------------------

# Function that will be called to finalize a user profile:
YNH_SETUP_USER = 'setup_user.setup_project_user'

SECRET_KEY = __get_or_create_secret(DATA_DIR_PATH / 'secret.txt')  # /home/yunohost.app/$app/secret.txt

# INSTALLED_APPS.append('<insert-your-app-here>')

# -----------------------------------------------------------------------------

至少您必须设置以下设置

from django_yunohost_integration.base_settings import *  # noqa

INSTALLED_APPS.append('django_yunohost_integration')

MIDDLEWARE.insert(
    MIDDLEWARE.index('django.contrib.auth.middleware.AuthenticationMiddleware') + 1,
    # login a user via HTTP_REMOTE_USER header from SSOwat:
    'django_yunohost_integration.sso_auth.auth_middleware.SSOwatRemoteUserMiddleware',
)

# Keep ModelBackend around for per-user permissions and superuser
AUTHENTICATION_BACKENDS = (
    'axes.backends.AxesBackend',  # AxesBackend should be the first backend!
    #
    # Authenticate via SSO and nginx 'HTTP_REMOTE_USER' header:
    'django_yunohost_integration.sso_auth.auth_backend.SSOwatUserBackend',
    #
    # Fallback to normal Django model backend:
    'django.contrib.auth.backends.ModelBackend',
)

LOGIN_REDIRECT_URL = None
LOGIN_URL = '/yunohost/sso/'
LOGOUT_REDIRECT_URL = '/yunohost/sso/'
# /yunohost/sso/?action=logout

ROOT_URLCONF = 'urls'  # .../conf/urls.py

本地测试

构建前提条件

例如，我们需要安装psycopg2（Python的PostgreSQL适配器），它需要一些构建前提条件

~$ sudo apt install build-essential python3-dev libpq-dev

为了在YunoHost应用环境中快速开发django_yunohost_integration，可以运行Django开发服务器，使用为YunoHost安装设置的设置和urls。

例如

~$ git clone https://github.com/YunoHost-Apps/django_yunohost_integration.git
~$ cd django_yunohost_integration/
~/django_yunohost_integration$ ./dev-cli.py

为了在YunoHost应用环境中快速开发django_yunohost_integration，可以运行Django开发服务器，使用为YunoHost安装设置的设置和urls。

例如

~/django_yunohost_integration$ ./dev-cli.py local-test

• 将使用SQLite数据库
• 将创建一个用户名为test、密码为test的超级用户
• 页面可在以下地址访问：http://127.0.0.1:8000/app_path/

历史记录

• v0.8.1
  • 2024-08-25 - 更新 assert_is_dir, assert_is_file 导入
  • 2024-08-25 - 修复 README 中的 codecov.io 徽章
  • 2024-08-25 - 修复 CI
  • 2024-08-25 - 更新需求
  • 2024-08-25 - 应用 manageprojects 更新
• v0.8.0
  • 2024-08-04 - 解决方案：[https://github.com/jazzband/pip-tools/issues/1866](https://github.com/jazzband/pip-tools/issues/1866)
  • 2024-08-04 - 修复本地 "manage.py" 辅助工具
  • 2024-08-04 - 更新需求
  • 2024-08-04 - 设置 Python 3.11 为最低版本
  • 2024-08-04 - 添加 pre-commit 脚本
  • 2024-08-04 - safety -> pip-audit
  • 2024-08-04 - 'psycopg2' -> 'psycopg[binary]'
  • 2024-08-04 - 使用 pre-commit 更新 README 中的历史记录
  • 2024-08-04 - 应用 manageprojects 更新
• v0.7.1
  • 2024-01-04 - 修复 create_local_test()
• v0.7.0
  • 2023-12-22 - 修复发布
  • 2023-12-22 - 更新项目设置
  • 2023-12-22 - 修复：意外关键字参数 'created'
  • 2023-08-22 - 更新 README.md

链接

• 关于此包的 bug 报告：https://github.com/YunoHost-Apps/django_yunohost_integration
• YunoHost 网站：https://yunohost.org/
• PyPi 包：https://pypi.ac.cn/project/django_yunohost_integration/