django_yunohost_integration

Python package django_yunohost_integration with helpers for integrate a Django project as YunoHost package.

A example usage of this package is here:

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

Pull requests welcome ;)

These projects used 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

Features

• SSOwat integration (see below)
• Helper to create first super user for scripts/install
• Run Django development server with a local generated YunoHost package installation (called local_test)
• Helper to run pytest against local_test "installation"

SSO authentication

SSOwat is fully supported:

• First user ($YNH_APP_ARG_ADMIN) will be created as Django's super user
• All new users will be created as normal users
• Login via SSO is fully supported
• User Email, First / Last name will be updated from SSO data

usage

To create/update the first user in install/upgrade, e.g.:

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

This Create/update Django superuser and set a unusable password. A password is not needed, because auth done via SSOwat ;)

Main parts in 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>')

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

At least you have to set these settings:

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

local test

Build prerequisites

We install psycopg2 (a PostgreSQL adapter for the Python) that needs some build prerequisites, e.g.:

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

For quicker developing of django_yunohost_integration in the context of YunoHost app, it's possible to run the Django developer server with the settings and urls made for YunoHost installation.

e.g.:

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

For quicker developing of django_yunohost_integration in the context of YunoHost app, it's possible to run the Django developer server with the settings and urls made for YunoHost installation.

e.g.:

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

• SQlite database will be used
• A super user with username test and password test is created
• The page is available under http://127.0.0.1:8000/app_path/

history

• v0.8.0
  • 2024-08-04 - work-a-round for: https://github.com/jazzband/pip-tools/issues/1866
  • 2024-08-04 - Bugfix local "manage.py" helper
  • 2024-08-04 - Update requirements
  • 2024-08-04 - Set Python 3.11 as minimum
  • 2024-08-04 - Add pre-commit scripts
  • 2024-08-04 - safety -> pip-audit
  • 2024-08-04 - 'psycopg2' -> 'psycopg[binary]'
  • 2024-08-04 - Use pre-commit to update history in README
  • 2024-08-04 - Apply manageprojects updates
• v0.7.1
  • 2024-01-04 - Bugfix create_local_test()
• v0.7.0
  • 2023-12-22 - Fix publish
  • 2023-12-22 - Update project setup
  • 2023-12-22 - Bugfix: unexpected keyword argument 'created'
  • 2023-08-22 - Update README.md
• v0.6.0
  • 2023-08-22 - Update requeirements, README and bump version to v0.6.0
  • 2023-08-20 - PATH_URL -> PATH
  • 2023-08-20 - update test
  • 2023-08-20 - Replace DEBUG_ENABLED with "YES" in local tests
  • 2023-08-20 - Update to YunoHost "Manifest v2"
  • 2023-02-19 - Replace devshell with a click CLI & replace pytest with normal unittests

Links

• Report a bug about this package: https://github.com/YunoHost-Apps/django_yunohost_integration
• YunoHost website: https://yunohost.org/
• PyPi package: https://pypi-hypernode.com/project/django_yunohost_integration/