django_example_ynh/doc/ADMIN.md

Settings and upgrades

Almost everything related to Django Example's configuration is handled in a "../conf/settings.py" file. You can edit the file /home/yunohost.app/django_example/local_settings.py to enable or disable features.

Test sending emails, e.g.:

ssh admin@yourdomain.tld
root@yunohost:~# /home/yunohost.app/django_example/manage.py sendtestemail --admins

Settings and upgrades

Almost everything related to Django Example's configuration is handled in a "../conf/settings.py" file. You can edit the file /home/yunohost.app/django_example/local_settings.py to enable or disable features.

Test sending emails, e.g.:

ssh admin@yourdomain.tld
root@yunohost:~# /home/yunohost.app/django_example/manage.py sendtestemail --admins

How to debug a django YunoHost app, take a look into:

• https://github.com/YunoHost-Apps/django_example_ynh#developer-info

local test

For quicker developing of django_example_ynh 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_example.git
~$ cd django_example_ynh/
~/django_example$ ./dev-cli.py --help

The output will looks like:

Usage: ./dev-cli.py [OPTIONS] COMMAND [ARGS]...

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --help      Show this message and exit.                                                          │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮
│ check-code-style            Check code style by calling darker + flake8                          │
│ coverage                    Run and show coverage.                                               │
│ diffsettings                Run "diffsettings" manage command against a "local_test" YunoHost    │
│                             installation.                                                        │
│ fix-code-style              Fix code style of all django_example_ynh source code files via       │
│                             darker                                                               │
│ install                     Run pip-sync and install 'django_example_ynh' via pip as editable.   │
│ local-test                  Build a "local_test" YunoHost installation and start the Django dev. │
│                             server against it.                                                   │
│ mypy                        Run Mypy (configured in pyproject.toml)                              │
│ publish                     Build and upload this project to PyPi                                │
│ safety                      Run safety check against current requirements files                  │
│ test                        Compile YunoHost files and run Django unittests                      │
│ tox                         Run tox                                                              │
│ update                      Update "requirements*.txt" dependencies files                        │
│ update-test-snapshot-files  Update all test snapshot files (by remove and recreate all snapshot  │
│                             files)                                                               │
│ version                     Print version and exit                                               │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯

Notes:

• 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

• compare v0.1.5...master dev
  • tbc
• v0.2.0 - 15.09.2021
  • rename/split django_example_ynh into:
    • django_yunohost_integration - Python package with the glue code to integrate a Django project with YunoHost
    • django_example_ynh - Demo YunoHost App to demonstrate the integration of a Django project under YunoHost
• v0.1.5 - 19.01.2021
  • Make some deps gunicorn, psycopg2-binary, django-redis, django-axes optional
• v0.1.4 - 08.01.2021
  • Bugfix CSRF verification failed on POST requests #7
• v0.1.3 - 08.01.2021
  • set "DEBUG = True" in local_test (so static files are served and auth works)
  • Bugfixes and cleanups
• v0.1.2 - 29.12.2020
  • Bugfixes
• v0.1.1 - 29.12.2020
  • Refactor "create_superuser" to a manage command, useable via "django_example_ynh" in INSTALLED_APPS
  • Generate "conf/requirements.txt" and use this file for install
  • rename own settings and urls (in /conf/)
• v0.1.0 - 28.12.2020
  • first working state
• 23.12.2020
  • init the project

Links

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

These projects used django_example_ynh:

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

---

Developer info

The App project will be stored under __DATA_DIR__ (e.g.: /home/yunohost.app/$app/) that's Django's settings.DATA_DIR_PATH "static" / "media" files to serve via nginx are under __INSTALL_DIR__ (e.g.: /var/www/$app/) that's settings.INSTALL_DIR_PATH

package installation / debugging

This app is not in YunoHost app catalog. Test install, e.g.:

~# git clone https://github.com/YunoHost-Apps/django_example_ynh.git
~# yunohost app install django_example_ynh/ -f

To update:

~# cd django_example_ynh
~/django_example_ynh# git fetch && git reset --hard origin/testing
~/django_example_ynh# yunohost app upgrade django_example -u . -F

To remove call e.g.:

sudo yunohost app remove django_example

Backup / remove / restore cycle, e.g.:

yunohost backup create --apps django_example
yunohost backup list
archives:
  - django_example_ynh-pre-upgrade1
  - 20230822-062848
yunohost app remove django_example
yunohost backup restore 20230822-062848 --apps django_example

Debug the installation, e.g.:

root@yunohost:~# cat /etc/yunohost/apps/django_example/settings.yml
...
app: django_example
...
data_dir: /home/yunohost.app/django_example
...
install_dir: /var/www/django_example
...
log_file: /var/log/django_example/django_example.log
...

root@yunohost:~# ls -la /var/www/django_example/
total 18
drwxr-xr-x 4 root root 4 Dec  8 08:36 .
drwxr-xr-x 6 root root 6 Dec  8 08:36 ..
drwxr-xr-x 2 root root 2 Dec  8 08:36 media
drwxr-xr-x 7 root root 8 Dec  8 08:40 static

root@yunohost:~# ls -la /home/yunohost.app/django_example/
total 58
drwxr-xr-x 5 django_example_ynh django_example_ynh   11 Dec  8 08:39 .
drwxr-xr-x 3 root        root           3 Dec  8 08:36 ..
-rw-r--r-- 1 django_example_ynh django_example_ynh  460 Dec  8 08:39 gunicorn.conf.py
-rw-r--r-- 1 django_example_ynh django_example_ynh    0 Dec  8 08:39 local_settings.py
-rwxr-xr-x 1 django_example_ynh django_example_ynh  274 Dec  8 08:39 manage.py
-rw-r--r-- 1 django_example_ynh django_example_ynh  171 Dec  8 08:39 secret.txt
drwxr-xr-x 6 django_example_ynh django_example_ynh    6 Dec  8 08:37 venv
-rw-r--r-- 1 django_example_ynh django_example_ynh  115 Dec  8 08:39 wsgi.py
-rw-r--r-- 1 django_example_ynh django_example_ynh 4737 Dec  8 08:39 django_example_ynh_demo_settings.py

root@yunohost:~# /home/yunohost.app/django_example/manage.py diffsettings
...
root@yunohost:~# /home/yunohost.app/django_example/manage.py check
ENV_TYPE:None
PROJECT_PATH:/home/yunohost.app/django_example/venv/lib/python3.9/site-packages
BASE_PATH:/root/django_example
System check identified no issues (0 silenced).

root@yunohost:~# cat /etc/systemd/system/django_example.service
...

root@yunohost:~# systemctl reload-or-restart django_example
root@yunohost:~# journalctl --unit=django_example --follow
...
root@yunohost:~# tail -f /var/log/django_example/django_example.log
...
root@yunohost:~# tail -f /var/log/nginx/*.log
...

root@yunohost:~# ls -la /etc/nginx/conf.d/
root@yunohost:~# cat /etc/nginx/conf.d/$domain.d/django_example.conf