django_example_ynh

Demo YunoHost Application to demonstrate the integration of a Django project under YunoHost.

Pull requests welcome ;)

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_ynh.git
~$ cd django_example_ynh/
~/django_example_ynh$ make
install-poetry         install or update poetry
install                install project via poetry
update                 update the sources and installation and generate "conf/requirements.txt"
lint                   Run code formatters and linter
fix-code-style         Fix code formatting
tox-listenvs           List all tox test environments
tox                    Run pytest via tox with all environments
pytest                 Run pytest
publish                Release new version to PyPi
local-test             Run local_test.py to run the project locally
local-diff-settings    Run "manage.py diffsettings" with local test

~/django_example_ynh$ make install-poetry
~/django_example_ynh$ make install
~/django_example_ynh$ make local-test

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_ynh
• 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_ynh
• https://github.com/YunoHost-Apps/django-for-runners_ynh

---

Developer info

package installation / debugging

Please send your pull request to https://github.com/YunoHost-Apps/django_example_ynh

Try 'main' branch, e.g.:

sudo yunohost app install https://github.com/YunoHost-Apps/django_example_ynh/tree/master --debug
or
sudo yunohost app upgrade django_example_ynh -u https://github.com/YunoHost-Apps/django_example_ynh/tree/master --debug

Try 'testing' branch, e.g.:

sudo yunohost app install https://github.com/YunoHost-Apps/django_example_ynh/tree/testing --debug
or
sudo yunohost app upgrade django_example_ynh -u https://github.com/YunoHost-Apps/django_example_ynh/tree/testing --debug

To remove call e.g.:

sudo yunohost app remove django_example_ynh

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

yunohost backup create --apps django_example_ynh
yunohost backup list
archives:
  - django_example_ynh-pre-upgrade1
  - 20201223-163434
yunohost app remove django_example_ynh
yunohost backup restore 20201223-163434 --apps django_example_ynh

Debug installation, e.g.:

root@yunohost:~# ls -la /var/www/django_example_ynh/
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 /opt/yunohost/django_example_ynh/
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:~# cd /opt/yunohost/django_example_ynh/
root@yunohost:/opt/yunohost/django_example_ynh# source venv/bin/activate
(venv) root@yunohost:/opt/yunohost/django_example_ynh# ./manage.py check
django_example_ynh v0.8.2 (Django v2.2.17)
DJANGO_SETTINGS_MODULE='django_example_ynh_demo_settings'
PROJECT_PATH:/opt/yunohost/django_example_ynh/venv/lib/python3.7/site-packages
BASE_PATH:/opt/yunohost/django_example_ynh
System check identified no issues (0 silenced).

root@yunohost:~# tail -f /var/log/django_example_ynh/django_example_ynh.log
root@yunohost:~# cat /etc/systemd/system/django_example_ynh.service

root@yunohost:~# systemctl reload-or-restart django_example_ynh
root@yunohost:~# journalctl --unit=django_example_ynh --follow