From a8a60bb4750906f3ea677c697677c4cbfc7d3181 Mon Sep 17 00:00:00 2001 From: JensDiemer Date: Sun, 14 Aug 2022 13:52:32 +0200 Subject: [PATCH] README -> /doc/ --- .gitignore | 1 + doc/DESCRIPTION.md | 9 +++ doc/DISCLAIMER.md | 133 +++++++++++++++++++++++++++++++++++++++ doc/screenshots/.gitkeep | 0 4 files changed, 143 insertions(+) create mode 100644 doc/DESCRIPTION.md create mode 100644 doc/DISCLAIMER.md create mode 100644 doc/screenshots/.gitkeep diff --git a/.gitignore b/.gitignore index d4aff27..3462408 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ !.editorconfig !.flake8 !.gitignore +!/doc/screenshots/.gitkeep __pycache__ secret.txt /local_test/ diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..37bc282 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1,9 @@ +[![pytest](https://github.com/YunoHost-Apps/django_example_ynh/actions/workflows/pytest.yml/badge.svg)](https://github.com/YunoHost-Apps/django_example_ynh/actions/workflows/pytest.yml) [![YunoHost apps package linter](https://github.com/YunoHost-Apps/django_example_ynh/actions/workflows/package_linter.yml/badge.svg)](https://github.com/YunoHost-Apps/django_example_ynh/actions/workflows/package_linter.yml) + +Demo [YunoHost Application](https://install-app.yunohost.org/?app=django_example_ynh) to demonstrate the integration of a Django project under YunoHost. + +[![Integration level](https://dash.yunohost.org/integration/django_example_ynh.svg)](https://dash.yunohost.org/appci/app/django_example_ynh) ![](https://ci-apps.yunohost.org/ci/badges/django_example_ynh.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/django_example_ynh.maintain.svg) +[![Install django_example_ynh with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django_example_ynh) + + +Pull requests welcome ;) diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..b7d5897 --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,133 @@ +## 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.: +```bash +~$ 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](https://github.com/YunoHost-Apps/django_example_ynh/compare/v0.2.0...master) **dev** + * tbc +* [v0.2.0 - 15.09.2021](https://github.com/YunoHost-Apps/django_example_ynh/compare/v0.1.5...v0.2.0) + * rename/split `django_example_ynh` into: + * [django_yunohost_integration](https://github.com/jedie/django_yunohost_integration) - Python package with the glue code to integrate a Django project with YunoHost + * [django_example_ynh](https://github.com/YunoHost-Apps/django_example_ynh) - Demo YunoHost App to demonstrate the integration of a Django project under YunoHost +* [v0.1.5 - 19.01.2021](https://github.com/YunoHost-Apps/django_example_ynh/compare/v0.1.4...v0.1.5) + * Make some deps `gunicorn`, `psycopg2-binary`, `django-redis`, `django-axes` optional +* [v0.1.4 - 08.01.2021](https://github.com/YunoHost-Apps/django_example_ynh/compare/v0.1.3...v0.1.4) + * Bugfix [CSRF verification failed on POST requests #7](https://github.com/YunoHost-Apps/django_example_ynh/issues/7) +* [v0.1.3 - 08.01.2021](https://github.com/YunoHost-Apps/django_example_ynh/compare/v0.1.2...v0.1.3) + * set "DEBUG = True" in local_test (so static files are served and auth works) + * Bugfixes and cleanups +* [v0.1.2 - 29.12.2020](https://github.com/YunoHost-Apps/django_example_ynh/compare/v0.1.1...v0.1.2) + * Bugfixes +* [v0.1.1 - 29.12.2020](https://github.com/YunoHost-Apps/django_example_ynh/compare/v0.1.0...v0.1.1) + * 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](https://github.com/YunoHost-Apps/django_example_ynh/compare/f578f14...v0.1.0) + * first working state +* [23.12.2020](https://github.com/YunoHost-Apps/django_example_ynh/commit/f578f144a3a6d11d7044597c37d550d29c247773) + * 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 + +To remove call e.g.: +```bash +sudo yunohost app remove django_example_ynh +``` + +Backup / remove / restore cycle, e.g.: +```bash +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.: +```bash +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 +``` + + diff --git a/doc/screenshots/.gitkeep b/doc/screenshots/.gitkeep new file mode 100644 index 0000000..e69de29