mirror of https://github.com/YunoHost-Apps/django_example_ynh.git synced 2024-09-03 18:26:21 +02:00

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

Find a file

JensDiemer 040c08438c README		2022-10-04 09:29:43 +02:00
.github	Update requirements and add saftey check	2022-09-15 11:42:01 +02:00
conf	assert_project_version()	2022-10-04 09:14:04 +02:00
doc	README	2022-10-04 09:29:43 +02:00
scripts	Bugfix "change_url"	2022-09-17 16:50:38 +02:00
tests	assert_project_version()	2022-10-04 09:14:04 +02:00
.editorconfig	fix editorconfig	2022-08-14 13:41:33 +02:00
.flake8	WIP: rename/split from django_ynh	2021-02-28 12:07:48 +01:00
.gitignore	README -> /doc/	2022-08-14 13:55:49 +02:00
check_process	Update check_process	2022-09-18 17:05:06 +02:00
config_panel.toml	Generic config panel example	2022-10-04 09:21:49 +02:00
LICENSE	init	2020-12-23 19:58:33 +01:00
local_test.py	Set settings.DEBUG via config_panel.toml	2022-08-14 20:40:33 +02:00
Makefile	poetry self update	2022-10-04 09:13:52 +02:00
manifest.json	Set version to v0.4.1	2022-10-04 09:15:27 +02:00
poetry.lock	assert_project_version()	2022-10-04 09:14:04 +02:00
pyproject.toml	Set version to v0.4.1	2022-10-04 09:15:27 +02:00
README.md	Auto-update README	2022-10-04 07:16:18 +00:00
README_fr.md	Auto-update README	2022-10-04 07:16:18 +00:00

README.md

Django Example for YunoHost

Lire ce readme en français.

This package allows you to install Django Example quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

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

Pull requests welcome ;)

Shipped version: 0.4.1~ynh1 (⚠️ This is the testing branch. The master branch used in the catalog is currently on version 0.4.0~ynh1.)

Disclaimers / important information

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

Developer info

The App project will be stored under __FINALPATH__ (e.g.: /opt/yunohost/$app) that's Django's settings.FINALPATH "static" / "media" files to serve via nginx are under __PUBLIC_PATH__ (e.g.: /var/www/$app) that's settings.PUBLIC_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_ynh -u . -F

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 the installation, e.g.:

root@yunohost:~# cat /etc/yunohost/apps/django_example_ynh/settings.yml
...

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/systemd.service
...

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

Documentation and resources

Official app website: https://github.com/YunoHost-Apps/django_example_ynh
Official user documentation: https://github.com/YunoHost-Apps/django_example_ynh
Official admin documentation: https://github.com/YunoHost-Apps/django_example_ynh
Upstream app code repository: https://github.com/YunoHost-Apps/django_example_ynh
YunoHost documentation for this app: https://yunohost.org/app_django_example_ynh
Report a bug: https://github.com/YunoHost-Apps/django_example_ynh_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

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

More info regarding app packaging: https://yunohost.org/packaging_apps

README.md

Django Example for YunoHost

Overview

Disclaimers / important information

local test

history

Links

Developer info

package installation / debugging

Documentation and resources

Developer info