YunoHost-Apps/scovie_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/scovie_ynh.git synced 2024-09-03 20:16:29 +02:00
Code Issues Activity Actions 2
scovie_ynh/README.md

209 lines
8.8 KiB
Markdown
Raw Normal View History

first commit
2023-05-26 19:09:08 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# Django Example for YunoHost
[![Integration level](https://dash.yunohost.org/integration/scovie_ynh.svg)](https://dash.yunohost.org/appci/app/scovie_ynh) ![Working status](https://ci-apps.yunohost.org/ci/badges/scovie_ynh.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/scovie_ynh.maintain.svg)
[![Install Django Example with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=scovie_ynh)
*[Lire ce readme en français.](./README_fr.md)*
> *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](https://yunohost.org/#/install) to learn how to install it.*
## Overview
update 7 files
2023-05-26 19:29:29 +02:00
[![pytest](https://github.com/eldertek/scovie_ynh/actions/workflows/pytest.yml/badge.svg)](https://github.com/eldertek/scovie_ynh/actions/workflows/pytest.yml) [![YunoHost apps package linter](https://github.com/eldertek/scovie_ynh/actions/workflows/package_linter.yml/badge.svg)](https://github.com/eldertek/scovie_ynh/actions/workflows/package_linter.yml)
first commit
2023-05-26 19:09:08 +02:00
update 7 files
2023-05-26 19:29:29 +02:00
Demo [YunoHost Application](https://install-app.yunohost.org/?app=scovie_ynh) to demonstrate the integration of a [Python](https://www.python.org/)/[Django](https://www.djangoproject.com/) project under YunoHost using [django_yunohost_integration](https://github.com/eldertek/django_yunohost_integration).
first commit
2023-05-26 19:09:08 +02:00
To demonstrate the functionality the small [django-example](https://github.com/jedie/django-example) app will be installed.
[![Integration level](https://dash.yunohost.org/integration/scovie_ynh.svg)](https://dash.yunohost.org/appci/app/scovie_ynh) ![](https://ci-apps.yunohost.org/ci/badges/scovie_ynh.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/scovie_ynh.maintain.svg)
[![Install scovie_ynh with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=scovie_ynh)
Pull requests welcome ;)
**Shipped version:** 0.5.0rc1~ynh1
## Disclaimers / important information
## local test
For quicker developing of scovie_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
update 7 files
2023-05-26 19:29:29 +02:00
~$ git clone https://github.com/eldertek/scovie_ynh.git
first commit
2023-05-26 19:09:08 +02:00
~$ cd scovie_ynh/
~/scovie_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
~/scovie_ynh$ make install-poetry
~/scovie_ynh$ make install
~/scovie_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
update 7 files
2023-05-26 19:29:29 +02:00
* [compare v0.1.5...master](https://github.com/eldertek/scovie_ynh/compare/v0.2.0...master) **dev**
first commit
2023-05-26 19:09:08 +02:00
* tbc
update 7 files
2023-05-26 19:29:29 +02:00
* [v0.2.0 - 15.09.2021](https://github.com/eldertek/scovie_ynh/compare/v0.1.5...v0.2.0)
first commit
2023-05-26 19:09:08 +02:00
* rename/split `scovie_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
update 7 files
2023-05-26 19:29:29 +02:00
* [scovie_ynh](https://github.com/eldertek/scovie_ynh) - Demo YunoHost App to demonstrate the integration of a Django project under YunoHost
* [v0.1.5 - 19.01.2021](https://github.com/eldertek/scovie_ynh/compare/v0.1.4...v0.1.5)
first commit
2023-05-26 19:09:08 +02:00
* Make some deps `gunicorn`, `psycopg2-binary`, `django-redis`, `django-axes` optional
update 7 files
2023-05-26 19:29:29 +02:00
* [v0.1.4 - 08.01.2021](https://github.com/eldertek/scovie_ynh/compare/v0.1.3...v0.1.4)
* Bugfix [CSRF verification failed on POST requests #7](https://github.com/eldertek/scovie_ynh/issues/7)
* [v0.1.3 - 08.01.2021](https://github.com/eldertek/scovie_ynh/compare/v0.1.2...v0.1.3)
first commit
2023-05-26 19:09:08 +02:00
* set "DEBUG = True" in local_test (so static files are served and auth works)
* Bugfixes and cleanups
update 7 files
2023-05-26 19:29:29 +02:00
* [v0.1.2 - 29.12.2020](https://github.com/eldertek/scovie_ynh/compare/v0.1.1...v0.1.2)
first commit
2023-05-26 19:09:08 +02:00
* Bugfixes
update 7 files
2023-05-26 19:29:29 +02:00
* [v0.1.1 - 29.12.2020](https://github.com/eldertek/scovie_ynh/compare/v0.1.0...v0.1.1)
first commit
2023-05-26 19:09:08 +02:00
* Refactor "create_superuser" to a manage command, useable via "scovie_ynh" in `INSTALLED_APPS`
* Generate "conf/requirements.txt" and use this file for install
* rename own settings and urls (in `/conf/`)
update 7 files
2023-05-26 19:29:29 +02:00
* [v0.1.0 - 28.12.2020](https://github.com/eldertek/scovie_ynh/compare/f578f14...v0.1.0)
first commit
2023-05-26 19:09:08 +02:00
* first working state
update 7 files
2023-05-26 19:29:29 +02:00
* [23.12.2020](https://github.com/eldertek/scovie_ynh/commit/f578f144a3a6d11d7044597c37d550d29c247773)
first commit
2023-05-26 19:09:08 +02:00
* init the project
## Links
update 7 files
2023-05-26 19:29:29 +02:00
* Report a bug about this package: https://github.com/eldertek/scovie_ynh
first commit
2023-05-26 19:09:08 +02:00
* YunoHost website: https://yunohost.org/
* PyPi package: https://pypi.org/project/django-ynh/
These projects used `scovie_ynh`:
update 7 files
2023-05-26 19:29:29 +02:00
* https://github.com/eldertek/scovie_ynh
* https://github.com/eldertek/django-for-runners_ynh
first commit
2023-05-26 19:09:08 +02:00
---
# 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.:
```bash
update 7 files
2023-05-26 19:29:29 +02:00
~# git clone https://github.com/eldertek/scovie_ynh.git
first commit
2023-05-26 19:09:08 +02:00
~# yunohost app install scovie_ynh/ -f
```
To update:
```bash
~# cd scovie_ynh
~/scovie_ynh# git fetch && git reset --hard origin/testing
~/scovie_ynh# yunohost app upgrade scovie_ynh -u . -F
```
To remove call e.g.:
```bash
sudo yunohost app remove scovie_ynh
```
Backup / remove / restore cycle, e.g.:
```bash
yunohost backup create --apps scovie_ynh
yunohost backup list
archives:
- scovie_ynh-pre-upgrade1
- 20201223-163434
yunohost app remove scovie_ynh
yunohost backup restore 20201223-163434 --apps scovie_ynh
```
Debug the installation, e.g.:
```bash
root@yunohost:~# cat /etc/yunohost/apps/scovie_ynh/settings.yml
...
root@yunohost:~# ls -la /var/www/scovie_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/scovie_ynh/
total 58
drwxr-xr-x 5 scovie_ynh scovie_ynh 11 Dec 8 08:39 .
drwxr-xr-x 3 root root 3 Dec 8 08:36 ..
-rw-r--r-- 1 scovie_ynh scovie_ynh 460 Dec 8 08:39 gunicorn.conf.py
-rw-r--r-- 1 scovie_ynh scovie_ynh 0 Dec 8 08:39 local_settings.py
-rwxr-xr-x 1 scovie_ynh scovie_ynh 274 Dec 8 08:39 manage.py
-rw-r--r-- 1 scovie_ynh scovie_ynh 171 Dec 8 08:39 secret.txt
drwxr-xr-x 6 scovie_ynh scovie_ynh 6 Dec 8 08:37 venv
-rw-r--r-- 1 scovie_ynh scovie_ynh 115 Dec 8 08:39 wsgi.py
-rw-r--r-- 1 scovie_ynh scovie_ynh 4737 Dec 8 08:39 scovie_ynh_demo_settings.py
root@yunohost:~# cd /opt/yunohost/scovie_ynh/
root@yunohost:/opt/yunohost/scovie_ynh# source venv/bin/activate
(venv) root@yunohost:/opt/yunohost/scovie_ynh# ./manage.py check
scovie_ynh v0.8.2 (Django v2.2.17)
DJANGO_SETTINGS_MODULE='scovie_ynh_demo_settings'
PROJECT_PATH:/opt/yunohost/scovie_ynh/venv/lib/python3.7/site-packages
BASE_PATH:/opt/yunohost/scovie_ynh
System check identified no issues (0 silenced).
root@yunohost:~# tail -f /var/log/scovie_ynh/scovie_ynh.log
root@yunohost:~# cat /etc/systemd/system/systemd.service
...
root@yunohost:~# systemctl reload-or-restart scovie_ynh
root@yunohost:~# journalctl --unit=scovie_ynh --follow
```
## Documentation and resources
update 7 files
2023-05-26 19:29:29 +02:00
* Official app website: <https://github.com/eldertek/scovie_ynh>
* Official user documentation: <https://github.com/eldertek/scovie_ynh>
* Official admin documentation: <https://github.com/eldertek/scovie_ynh>
* Upstream app code repository: <https://github.com/eldertek/scovie_ynh>
first commit
2023-05-26 19:09:08 +02:00
* YunoHost documentation for this app: <https://yunohost.org/app_scovie_ynh>
update 7 files
2023-05-26 19:29:29 +02:00
* Report a bug: <https://github.com/eldertek/scovie_ynh_ynh/issues>
first commit
2023-05-26 19:09:08 +02:00
## Developer info
update 7 files
2023-05-26 19:29:29 +02:00
Please send your pull request to the [testing branch](https://github.com/eldertek/scovie_ynh_ynh/tree/testing).
first commit
2023-05-26 19:09:08 +02:00
To try the testing branch, please proceed like that.
``` bash
update 7 files
2023-05-26 19:29:29 +02:00
sudo yunohost app install https://github.com/eldertek/scovie_ynh_ynh/tree/testing --debug
first commit
2023-05-26 19:09:08 +02:00
or
update 7 files
2023-05-26 19:29:29 +02:00
sudo yunohost app upgrade scovie_ynh -u https://github.com/eldertek/scovie_ynh_ynh/tree/testing --debug
first commit
2023-05-26 19:09:08 +02:00
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
Reference in a new issue Copy permalink