From 55f256e27f5e2749aed7982501ed2f764097ed21 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Fri, 29 Mar 2024 07:00:09 +0100 Subject: [PATCH 1/5] Auto-update README --- ALL_README.md | 6 ++ README.md | 30 +++---- README_fr.md | 36 ++++---- README_gl.md | 222 ++++++++++++++++++++++++++++++++++++++++++++++++++ README_it.md | 222 ++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 483 insertions(+), 33 deletions(-) create mode 100644 ALL_README.md create mode 100644 README_gl.md create mode 100644 README_it.md diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..3d6c579 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,6 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Lire le README en français](README_fr.md) +- [Le o README en galego](README_gl.md) +- [Leggi il “README” in italiano](README_it.md) diff --git a/README.md b/README.md index bf2053b..b9b8fc2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Install django-for-runners with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-for-runners) -*[Lire ce readme en français.](./README_fr.md)* +*[Read this README is other languages.](./ALL_README.md)* -> *This package allows you to install django-for-runners 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.* +> *This package allows you to install django-for-runners 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 @@ -38,9 +38,9 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Screenshots -![Screenshot of django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) -![Screenshot of django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Screenshot of django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) +![Screenshot of django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Screenshot of django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) ## Disclaimers / important information @@ -200,20 +200,20 @@ Notes: ## Documentation and resources -* Official app website: -* Official user documentation: -* Official admin documentation: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official app website: +- Official user documentation: +- Official admin documentation: +- Upstream app code repository: +- YunoHost Store: +- Report a bug: ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing). +Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing). -To try the testing branch, please proceed like that. +To try the `testing` branch, please proceed like that: -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug or sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug diff --git a/README_fr.md b/README_fr.md index 5dc38d1..775bf98 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # django-for-runners pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![Installer django-for-runners avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-for-runners) -*[Read this readme in english.](./README.md)* +*[Lire le README dans d'autres langues.](./ALL_README.md)* -> *Ce package vous permet d’installer django-for-runners rapidement et simplement sur un serveur YunoHost. -Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.* +> *Ce package vous permet d’installer django-for-runners rapidement et simplement sur un serveur YunoHost.* +> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* ## Vue d’ensemble @@ -34,13 +34,13 @@ This package for YunoHost used [django-yunohost-integration](https://github.com/ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-runners](https://github.com/jedie/jedie.github.io/tree/master/screenshots/django-for-runners/README.creole) -**Version incluse :** 0.17.4~ynh1 +**Version incluse :** 0.17.4~ynh1 ## Captures d’écran -![Capture d’écran de django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) -![Capture d’écran de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Capture d’écran de django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) +![Capture d’écran de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Capture d’écran de django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) ## Avertissements / informations importantes @@ -200,23 +200,23 @@ Notes: ## Documentations et ressources -* Site officiel de l’app : -* Documentation officielle utilisateur : -* Documentation officielle de l’admin : -* Dépôt de code officiel de l’app : -* YunoHost Store: -* Signaler un bug : +- Site officiel de l’app : +- Documentation officielle utilisateur : +- Documentation officielle de l’admin : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing). +Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing). -Pour essayer la branche testing, procédez comme suit. +Pour essayer la branche `testing`, procédez comme suit : -``` bash +```bash sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug ou sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug ``` -**Plus d’infos sur le packaging d’applications :** \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md new file mode 100644 index 0000000..aad4566 --- /dev/null +++ b/README_gl.md @@ -0,0 +1,222 @@ + + +# django-for-runners para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/django-for-runners.svg)](https://dash.yunohost.org/appci/app/django-for-runners) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/django-for-runners.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/django-for-runners.maintain.svg) + +[![Instalar django-for-runners con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-for-runners) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar django-for-runners de xeito rápido e doado nun servidor YunoHost.* +> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* + +## Vista xeral + +![Logo](https://raw.githubusercontent.com/jedie/django-for-runners/main/for_runners/static/Django-ForRunners128.png) + +[django-for-runners](https://github.com/jedie/django-for-runners) is a libre web-based management for your GPX tracks of your running (or other sports activity). Used [Python](https://www.python.org/)/[Django](https://www.djangoproject.com/). + + +[![pytest](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/pytest.yml/badge.svg?branch=master)](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/pytest.yml) [![YunoHost apps package linter](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/package_linter.yml/badge.svg)](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/package_linter.yml) [![Coverage Status on codecov.io](https://codecov.io/gh/YunoHost-Apps/django-for-runners_ynh/branch/master/graph/badge.svg)](https://codecov.io/gh/YunoHost-Apps/django-for-runners_ynh) + +![django-for-runners @ PyPi](https://img.shields.io/pypi/v/django-for-runners?label=django-for-runners%20%40%20PyPi) +![Python Versions](https://img.shields.io/pypi/pyversions/django-for-runners) +![License GPL V3+](https://img.shields.io/pypi/l/django-for-runners) + +Pull requests welcome ;) + +This package for YunoHost used [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration) + +More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-runners](https://github.com/jedie/jedie.github.io/tree/master/screenshots/django-for-runners/README.creole) + + +**Versión proporcionada:** 0.17.4~ynh1 + +## Capturas de pantalla + +![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) +![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Captura de pantalla de django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) + +## Avisos / información importante + +## Settings and upgrades + +Almost everything related to django-for-runners's configuration is handled in a `"../conf/settings.py"` file. +You can edit the file `/opt/yunohost/django-for-runners/local_settings.py` to enable or disable features. + +Test sending emails: + +```bash +ssh admin@yourdomain.tld +root@yunohost:~# cd /opt/yunohost/django-for-runners/ +root@yunohost:/opt/yunohost/django-for-runners# source venv/bin/activate +(venv) root@yunohost:/opt/yunohost/django-for-runners# ./manage.py sendtestemail --admins +``` + +Background info: Error mails are send to all [settings.ADMINS](https://docs.djangoproject.com/en/2.2/ref/settings/#std:setting-ADMINS). By default the YunoHost admin is inserted here. +To check current ADMINS run: + +```bash +(venv) root@yunohost:/opt/yunohost/django-for-runners# ./manage.py sendtestemail --admins +``` + +If you prefere to send error emails to a extrnal email address, just do something like this: + +```bash +echo "ADMINS = (('Your Name', 'example@domain.tld'),)" >> /opt/yunohost/django-for-runners/local_settings.py +``` + +To check the effective settings, run this: +```bash +(venv) root@yunohost:/opt/yunohost/django-for-runners# ./manage.py diffsettings +``` + + +# Miscellaneous + + +## SSO authentication + +[SSOwat](https://github.com/YunoHost/SSOwat) is fully supported via [django_ynh](https://github.com/YunoHost-Apps/django_ynh): + +* First user (`$YNH_APP_ARG_ADMIN`) will be created as Django's super user +* All new users will be created as normal users +* Login via SSO is fully supported +* User Email, First / Last name will be updated from SSO data + + +## Links + + * Report a bug about this package: https://github.com/YunoHost-Apps/django-for-runners_ynh + * Report a bug about django-for-runners itself: https://github.com/jedie/django-for-runners + * YunoHost website: https://yunohost.org/ + +--- + +# Developer info + +## package installation / debugging + +Please send your pull request to https://github.com/YunoHost-Apps/django-for-runners_ynh + +Try 'main' branch, e.g.: +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/master --debug +or +sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/master --debug +``` + +Try 'testing' branch, e.g.: +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug +or +sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug +``` + +To remove call e.g.: +```bash +sudo yunohost app remove django-for-runners +``` + +Backup / remove / restore cycle, e.g.: +```bash +yunohost backup create --apps django-for-runners +yunohost backup list +archives: + - django-for-runners-pre-upgrade1 + - 20201223-163434 +yunohost app remove django-for-runners +yunohost backup restore 20201223-163434 --apps django-for-runners +``` + +Debug installation, e.g.: +```bash +root@yunohost:~# ls -la /var/www/django-for-runners/ +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-for-runners/ +total 58 +drwxr-xr-x 5 django-for-runners django-for-runners 11 Dec 8 08:39 . +drwxr-xr-x 3 root root 3 Dec 8 08:36 .. +-rw-r--r-- 1 django-for-runners django-for-runners 460 Dec 8 08:39 gunicorn.conf.py +-rw-r--r-- 1 django-for-runners django-for-runners 0 Dec 8 08:39 local_settings.py +-rwxr-xr-x 1 django-for-runners django-for-runners 274 Dec 8 08:39 manage.py +-rw-r--r-- 1 django-for-runners django-for-runners 171 Dec 8 08:39 secret.txt +drwxr-xr-x 6 django-for-runners django-for-runners 6 Dec 8 08:37 venv +-rw-r--r-- 1 django-for-runners django-for-runners 115 Dec 8 08:39 wsgi.py +-rw-r--r-- 1 django-for-runners django-for-runners 4737 Dec 8 08:39 settings.py + +root@yunohost:~# cd /opt/yunohost/django-for-runners/ +root@yunohost:/opt/yunohost/django-for-runners# source venv/bin/activate +(venv) root@yunohost:/opt/yunohost/django-for-runners# ./manage.py check +django-for-runners v0.8.2 (Django v2.2.17) +DJANGO_SETTINGS_MODULE='settings' +PROJECT_PATH:/opt/yunohost/django-for-runners/venv/lib/python3.7/site-packages +BASE_PATH:/opt/yunohost/django-for-runners +System check identified no issues (0 silenced). + +root@yunohost:~# tail -f /var/log/django-for-runners/django-for-runners.log +root@yunohost:~# cat /etc/systemd/system/django-for-runners.service + +root@yunohost:~# systemctl reload-or-restart django-for-runners +root@yunohost:~# systemctl status django-for-runners +root@yunohost:~# journalctl --unit=for_runners --follow +``` + +## local test + +For quicker developing of django-for-runners 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-for-runners_ynh.git +~$ cd django-for-runners_ynh/ +~/django-for-runners_ynh$ make +install-poetry install or update poetry +install install django-for-runners via poetry +update update the sources and installation +local-test Run local_test.py to run django-for-runners_ynh locally +~/django-for-runners_ynh$ make install-poetry +~/django-for-runners_ynh$ make install +~/django-for-runners_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/` + +## Documentación e recursos + +- Web oficial da app: +- Documentación oficial para usuarias: +- Documentación oficial para admin: +- Repositorio de orixe do código: +- Tenda YunoHost: +- Informar dun problema: + +## Info de desenvolvemento + +Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug +ou +sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:** diff --git a/README_it.md b/README_it.md new file mode 100644 index 0000000..ee032db --- /dev/null +++ b/README_it.md @@ -0,0 +1,222 @@ + + +# django-for-runners per YunoHost + +[![Livello di integrazione](https://dash.yunohost.org/integration/django-for-runners.svg)](https://dash.yunohost.org/appci/app/django-for-runners) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/django-for-runners.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/django-for-runners.maintain.svg) + +[![Installa django-for-runners con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-for-runners) + +*[Leggi questo README in altre lingue.](./ALL_README.md)* + +> *Questo pacchetto ti permette di installare django-for-runners su un server YunoHost in modo semplice e veloce.* +> *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.* + +## Panoramica + +![Logo](https://raw.githubusercontent.com/jedie/django-for-runners/main/for_runners/static/Django-ForRunners128.png) + +[django-for-runners](https://github.com/jedie/django-for-runners) is a libre web-based management for your GPX tracks of your running (or other sports activity). Used [Python](https://www.python.org/)/[Django](https://www.djangoproject.com/). + + +[![pytest](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/pytest.yml/badge.svg?branch=master)](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/pytest.yml) [![YunoHost apps package linter](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/package_linter.yml/badge.svg)](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/package_linter.yml) [![Coverage Status on codecov.io](https://codecov.io/gh/YunoHost-Apps/django-for-runners_ynh/branch/master/graph/badge.svg)](https://codecov.io/gh/YunoHost-Apps/django-for-runners_ynh) + +![django-for-runners @ PyPi](https://img.shields.io/pypi/v/django-for-runners?label=django-for-runners%20%40%20PyPi) +![Python Versions](https://img.shields.io/pypi/pyversions/django-for-runners) +![License GPL V3+](https://img.shields.io/pypi/l/django-for-runners) + +Pull requests welcome ;) + +This package for YunoHost used [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration) + +More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-runners](https://github.com/jedie/jedie.github.io/tree/master/screenshots/django-for-runners/README.creole) + + +**Versione pubblicata:** 0.17.4~ynh1 + +## Screenshot + +![Screenshot di django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) +![Screenshot di django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Screenshot di django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) + +## Attenzione/informazioni importanti + +## Settings and upgrades + +Almost everything related to django-for-runners's configuration is handled in a `"../conf/settings.py"` file. +You can edit the file `/opt/yunohost/django-for-runners/local_settings.py` to enable or disable features. + +Test sending emails: + +```bash +ssh admin@yourdomain.tld +root@yunohost:~# cd /opt/yunohost/django-for-runners/ +root@yunohost:/opt/yunohost/django-for-runners# source venv/bin/activate +(venv) root@yunohost:/opt/yunohost/django-for-runners# ./manage.py sendtestemail --admins +``` + +Background info: Error mails are send to all [settings.ADMINS](https://docs.djangoproject.com/en/2.2/ref/settings/#std:setting-ADMINS). By default the YunoHost admin is inserted here. +To check current ADMINS run: + +```bash +(venv) root@yunohost:/opt/yunohost/django-for-runners# ./manage.py sendtestemail --admins +``` + +If you prefere to send error emails to a extrnal email address, just do something like this: + +```bash +echo "ADMINS = (('Your Name', 'example@domain.tld'),)" >> /opt/yunohost/django-for-runners/local_settings.py +``` + +To check the effective settings, run this: +```bash +(venv) root@yunohost:/opt/yunohost/django-for-runners# ./manage.py diffsettings +``` + + +# Miscellaneous + + +## SSO authentication + +[SSOwat](https://github.com/YunoHost/SSOwat) is fully supported via [django_ynh](https://github.com/YunoHost-Apps/django_ynh): + +* First user (`$YNH_APP_ARG_ADMIN`) will be created as Django's super user +* All new users will be created as normal users +* Login via SSO is fully supported +* User Email, First / Last name will be updated from SSO data + + +## Links + + * Report a bug about this package: https://github.com/YunoHost-Apps/django-for-runners_ynh + * Report a bug about django-for-runners itself: https://github.com/jedie/django-for-runners + * YunoHost website: https://yunohost.org/ + +--- + +# Developer info + +## package installation / debugging + +Please send your pull request to https://github.com/YunoHost-Apps/django-for-runners_ynh + +Try 'main' branch, e.g.: +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/master --debug +or +sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/master --debug +``` + +Try 'testing' branch, e.g.: +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug +or +sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug +``` + +To remove call e.g.: +```bash +sudo yunohost app remove django-for-runners +``` + +Backup / remove / restore cycle, e.g.: +```bash +yunohost backup create --apps django-for-runners +yunohost backup list +archives: + - django-for-runners-pre-upgrade1 + - 20201223-163434 +yunohost app remove django-for-runners +yunohost backup restore 20201223-163434 --apps django-for-runners +``` + +Debug installation, e.g.: +```bash +root@yunohost:~# ls -la /var/www/django-for-runners/ +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-for-runners/ +total 58 +drwxr-xr-x 5 django-for-runners django-for-runners 11 Dec 8 08:39 . +drwxr-xr-x 3 root root 3 Dec 8 08:36 .. +-rw-r--r-- 1 django-for-runners django-for-runners 460 Dec 8 08:39 gunicorn.conf.py +-rw-r--r-- 1 django-for-runners django-for-runners 0 Dec 8 08:39 local_settings.py +-rwxr-xr-x 1 django-for-runners django-for-runners 274 Dec 8 08:39 manage.py +-rw-r--r-- 1 django-for-runners django-for-runners 171 Dec 8 08:39 secret.txt +drwxr-xr-x 6 django-for-runners django-for-runners 6 Dec 8 08:37 venv +-rw-r--r-- 1 django-for-runners django-for-runners 115 Dec 8 08:39 wsgi.py +-rw-r--r-- 1 django-for-runners django-for-runners 4737 Dec 8 08:39 settings.py + +root@yunohost:~# cd /opt/yunohost/django-for-runners/ +root@yunohost:/opt/yunohost/django-for-runners# source venv/bin/activate +(venv) root@yunohost:/opt/yunohost/django-for-runners# ./manage.py check +django-for-runners v0.8.2 (Django v2.2.17) +DJANGO_SETTINGS_MODULE='settings' +PROJECT_PATH:/opt/yunohost/django-for-runners/venv/lib/python3.7/site-packages +BASE_PATH:/opt/yunohost/django-for-runners +System check identified no issues (0 silenced). + +root@yunohost:~# tail -f /var/log/django-for-runners/django-for-runners.log +root@yunohost:~# cat /etc/systemd/system/django-for-runners.service + +root@yunohost:~# systemctl reload-or-restart django-for-runners +root@yunohost:~# systemctl status django-for-runners +root@yunohost:~# journalctl --unit=for_runners --follow +``` + +## local test + +For quicker developing of django-for-runners 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-for-runners_ynh.git +~$ cd django-for-runners_ynh/ +~/django-for-runners_ynh$ make +install-poetry install or update poetry +install install django-for-runners via poetry +update update the sources and installation +local-test Run local_test.py to run django-for-runners_ynh locally +~/django-for-runners_ynh$ make install-poetry +~/django-for-runners_ynh$ make install +~/django-for-runners_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/` + +## Documentazione e risorse + +- Sito web ufficiale dell’app: +- Documentazione ufficiale per gli utenti: +- Documentazione ufficiale per gli amministratori: +- Repository upstream del codice dell’app: +- Store di YunoHost: +- Segnala un problema: + +## Informazioni per sviluppatori + +Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing). + +Per provare la branch di `testing`, si prega di procedere in questo modo: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug +o +sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug +``` + +**Maggiori informazioni riguardo il pacchetto di quest’app:** From 7f8069dfc9babc3ab01c1e1867a7abcd27db7498 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Fri, 29 Mar 2024 06:00:14 +0000 Subject: [PATCH 2/5] Auto-update READMEs --- README.md | 4 ++-- README_fr.md | 4 ++-- README_gl.md | 4 ++-- README_it.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b9b8fc2..09ca456 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,9 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Screenshots -![Screenshot of django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) -![Screenshot of django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Screenshot of django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) +![Screenshot of django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Screenshot of django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) ## Disclaimers / important information diff --git a/README_fr.md b/README_fr.md index 775bf98..7b8b0ed 100644 --- a/README_fr.md +++ b/README_fr.md @@ -38,9 +38,9 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Captures d’écran -![Capture d’écran de django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) -![Capture d’écran de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Capture d’écran de django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) +![Capture d’écran de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Capture d’écran de django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) ## Avertissements / informations importantes diff --git a/README_gl.md b/README_gl.md index aad4566..4ce84ea 100644 --- a/README_gl.md +++ b/README_gl.md @@ -38,9 +38,9 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Capturas de pantalla -![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) -![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Captura de pantalla de django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) +![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) ## Avisos / información importante diff --git a/README_it.md b/README_it.md index ee032db..b8ad18c 100644 --- a/README_it.md +++ b/README_it.md @@ -38,9 +38,9 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Screenshot -![Screenshot di django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) -![Screenshot di django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Screenshot di django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) +![Screenshot di django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Screenshot di django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) ## Attenzione/informazioni importanti From 5f60e9e04701182724e1b1f9ed48f282c4a449e4 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sat, 30 Mar 2024 03:15:13 +0100 Subject: [PATCH 3/5] Auto-update README --- README.md | 4 ++-- README_fr.md | 4 ++-- README_gl.md | 4 ++-- README_it.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 09ca456..b9b8fc2 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,9 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Screenshots -![Screenshot of django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) -![Screenshot of django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Screenshot of django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) +![Screenshot of django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Screenshot of django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) ## Disclaimers / important information diff --git a/README_fr.md b/README_fr.md index 7b8b0ed..775bf98 100644 --- a/README_fr.md +++ b/README_fr.md @@ -38,9 +38,9 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Captures d’écran -![Capture d’écran de django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) -![Capture d’écran de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Capture d’écran de django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) +![Capture d’écran de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Capture d’écran de django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) ## Avertissements / informations importantes diff --git a/README_gl.md b/README_gl.md index 4ce84ea..aad4566 100644 --- a/README_gl.md +++ b/README_gl.md @@ -38,9 +38,9 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Capturas de pantalla -![Captura de pantalla de django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) -![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) +![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Captura de pantalla de django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) ## Avisos / información importante diff --git a/README_it.md b/README_it.md index b8ad18c..ee032db 100644 --- a/README_it.md +++ b/README_it.md @@ -38,9 +38,9 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Screenshot -![Screenshot di django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) -![Screenshot di django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Screenshot di django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) +![Screenshot di django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Screenshot di django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) ## Attenzione/informazioni importanti From 537e369d31b09d991a994af5544e4beeb7fa95ae Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sat, 30 Mar 2024 02:15:20 +0000 Subject: [PATCH 4/5] Auto-update READMEs --- README.md | 4 ++-- README_fr.md | 4 ++-- README_gl.md | 4 ++-- README_it.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b9b8fc2..09ca456 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,9 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Screenshots -![Screenshot of django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) -![Screenshot of django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Screenshot of django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) +![Screenshot of django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Screenshot of django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) ## Disclaimers / important information diff --git a/README_fr.md b/README_fr.md index 775bf98..7b8b0ed 100644 --- a/README_fr.md +++ b/README_fr.md @@ -38,9 +38,9 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Captures d’écran -![Capture d’écran de django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) -![Capture d’écran de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Capture d’écran de django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) +![Capture d’écran de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Capture d’écran de django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) ## Avertissements / informations importantes diff --git a/README_gl.md b/README_gl.md index aad4566..4ce84ea 100644 --- a/README_gl.md +++ b/README_gl.md @@ -38,9 +38,9 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Capturas de pantalla -![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) -![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Captura de pantalla de django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) +![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) ## Avisos / información importante diff --git a/README_it.md b/README_it.md index ee032db..b8ad18c 100644 --- a/README_it.md +++ b/README_it.md @@ -38,9 +38,9 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Screenshot -![Screenshot di django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) -![Screenshot di django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Screenshot di django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) +![Screenshot di django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Screenshot di django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) ## Attenzione/informazioni importanti From 8a25248556ae766571187ea6b7ca7aeaff3bbe58 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Mon, 13 May 2024 19:04:05 +0000 Subject: [PATCH 5/5] Auto-update READMEs --- ALL_README.md | 4 +- README.md | 12 ++-- README_es.md | 62 +++++++++++++++++ README_eu.md | 62 +++++++++++++++++ README_fr.md | 10 +-- README_gl.md | 170 ++-------------------------------------------- README_zh_Hans.md | 62 +++++++++++++++++ 7 files changed, 205 insertions(+), 177 deletions(-) create mode 100644 README_es.md create mode 100644 README_eu.md create mode 100644 README_zh_Hans.md diff --git a/ALL_README.md b/ALL_README.md index 3d6c579..8938aae 100644 --- a/ALL_README.md +++ b/ALL_README.md @@ -1,6 +1,8 @@ # All available README files by language - [Read the README in English](README.md) +- [Lee el README en español](README_es.md) +- [Irakurri README euskaraz](README_eu.md) - [Lire le README en français](README_fr.md) - [Le o README en galego](README_gl.md) -- [Leggi il “README” in italiano](README_it.md) +- [阅读中文（简体）的 README](README_zh_Hans.md) diff --git a/README.md b/README.md index 174df75..25a7966 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ It shall NOT be edited by hand. [![Install django-for-runners with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-for-runners) -*[Read this README is other languages.](./ALL_README.md)* +*[Read this README in other languages.](./ALL_README.md)* > *This package allows you to install django-for-runners 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.* @@ -41,11 +41,11 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Documentation and resources -* Official user documentation: -* Official admin documentation: -* Upstream app code repository: -* YunoHost Store: -* Report a bug: +- Official user documentation: +- Official admin documentation: +- Upstream app code repository: +- YunoHost Store: +- Report a bug: ## Developer info diff --git a/README_es.md b/README_es.md new file mode 100644 index 0000000..f97aa36 --- /dev/null +++ b/README_es.md @@ -0,0 +1,62 @@ + + +# django-for-runners para Yunohost + +[![Nivel de integración](https://dash.yunohost.org/integration/django-for-runners.svg)](https://dash.yunohost.org/appci/app/django-for-runners) ![Estado funcional](https://ci-apps.yunohost.org/ci/badges/django-for-runners.status.svg) ![Estado En Mantención](https://ci-apps.yunohost.org/ci/badges/django-for-runners.maintain.svg) + +[![Instalar django-for-runners con Yunhost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-for-runners) + +*[Leer este README en otros idiomas.](./ALL_README.md)* + +> *Este paquete le permite instalardjango-for-runners rapidamente y simplement en un servidor YunoHost.* +> *Si no tiene YunoHost, visita [the guide](https://yunohost.org/install) para aprender como instalarla.* + +## Descripción general + +[![tests](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/tests.yml) +[![codecov](https://codecov.io/github/jedie/for_runners_ynh/branch/main/graph/badge.svg)](https://app.codecov.io/github/jedie/for_runners_ynh) +[![for_runners_ynh @ PyPi](https://img.shields.io/pypi/v/for_runners_ynh?label=for_runners_ynh%20%40%20PyPi)](https://pypi.org/project/for_runners_ynh/) +[![Python Versions](https://img.shields.io/pypi/pyversions/for_runners_ynh)](https://github.com/YunoHost-Apps/django-for-runners_ynh/blob/main/pyproject.toml) +[![License GPL-3.0-or-later](https://img.shields.io/pypi/l/for_runners_ynh)](https://github.com/YunoHost-Apps/django-for-runners_ynh/blob/main/LICENSE) + +[django-for-runners](https://github.com/jedie/django-for-runners) is a libre web-based management for your GPX tracks of your running (or other sports activity). Used [Python](https://www.python.org/)/[Django](https://www.djangoproject.com/). + +Pull requests welcome ;) + +This package for YunoHost used [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration) + +More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-runners](https://github.com/jedie/jedie.github.io/tree/master/screenshots/django-for-runners/README.creole) + + +**Versión actual:** 0.17.4~ynh1 + +## Capturas + +![Captura de django-for-runners](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) +![Captura de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![Captura de django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) + +## Documentaciones y recursos + +- Documentación usuario oficial: +- Documentación administrador oficial: +- Repositorio del código fuente oficial de la aplicación : +- Catálogo YunoHost: +- Reportar un error: + +## Información para desarrolladores + +Por favor enviar sus correcciones a la [`branch testing`](https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing + +Para probar la rama `testing`, sigue asÍ: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug +o +sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug +``` + +**Mas informaciones sobre el empaquetado de aplicaciones:** diff --git a/README_eu.md b/README_eu.md new file mode 100644 index 0000000..3db3fe3 --- /dev/null +++ b/README_eu.md @@ -0,0 +1,62 @@ + + +# django-for-runners YunoHost-erako + +[![Integrazio maila](https://dash.yunohost.org/integration/django-for-runners.svg)](https://dash.yunohost.org/appci/app/django-for-runners) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/django-for-runners.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/django-for-runners.maintain.svg) + +[![Instalatu django-for-runners YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-for-runners) + +*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* + +> *Pakete honek django-for-runners YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* +> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* + +## Aurreikuspena + +[![tests](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/tests.yml) +[![codecov](https://codecov.io/github/jedie/for_runners_ynh/branch/main/graph/badge.svg)](https://app.codecov.io/github/jedie/for_runners_ynh) +[![for_runners_ynh @ PyPi](https://img.shields.io/pypi/v/for_runners_ynh?label=for_runners_ynh%20%40%20PyPi)](https://pypi.org/project/for_runners_ynh/) +[![Python Versions](https://img.shields.io/pypi/pyversions/for_runners_ynh)](https://github.com/YunoHost-Apps/django-for-runners_ynh/blob/main/pyproject.toml) +[![License GPL-3.0-or-later](https://img.shields.io/pypi/l/for_runners_ynh)](https://github.com/YunoHost-Apps/django-for-runners_ynh/blob/main/LICENSE) + +[django-for-runners](https://github.com/jedie/django-for-runners) is a libre web-based management for your GPX tracks of your running (or other sports activity). Used [Python](https://www.python.org/)/[Django](https://www.djangoproject.com/). + +Pull requests welcome ;) + +This package for YunoHost used [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration) + +More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-runners](https://github.com/jedie/jedie.github.io/tree/master/screenshots/django-for-runners/README.creole) + + +**Paketatutako bertsioa:** 0.17.4~ynh1 + +## Pantaila-argazkiak + +![django-for-runners(r)en pantaila-argazkia](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) +![django-for-runners(r)en pantaila-argazkia](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![django-for-runners(r)en pantaila-argazkia](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) + +## Dokumentazioa eta baliabideak + +- Erabiltzaileen dokumentazio ofiziala: +- Administratzaileen dokumentazio ofiziala: +- Jatorrizko aplikazioaren kode-gordailua: +- YunoHost Denda: +- Eman errore baten berri: + +## Garatzaileentzako informazioa + +Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing). + +`testing` abarra probatzeko, ondorengoa egin: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug +edo +sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug +``` + +**Informazio gehiago aplikazioaren paketatzeari buruz:** diff --git a/README_fr.md b/README_fr.md index 2f27b84..636d05f 100644 --- a/README_fr.md +++ b/README_fr.md @@ -41,11 +41,11 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ## Documentations et ressources -* Documentation officielle utilisateur : -* Documentation officielle de l’admin : -* Dépôt de code officiel de l’app : -* YunoHost Store: -* Signaler un bug : +- Documentation officielle utilisateur : +- Documentation officielle de l’admin : +- Dépôt de code officiel de l’app : +- YunoHost Store : +- Signaler un bug : ## Informations pour les développeurs diff --git a/README_gl.md b/README_gl.md index 4ce84ea..80bf26b 100644 --- a/README_gl.md +++ b/README_gl.md @@ -16,17 +16,14 @@ NON debe editarse manualmente. ## Vista xeral -![Logo](https://raw.githubusercontent.com/jedie/django-for-runners/main/for_runners/static/Django-ForRunners128.png) +[![tests](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/tests.yml) +[![codecov](https://codecov.io/github/jedie/for_runners_ynh/branch/main/graph/badge.svg)](https://app.codecov.io/github/jedie/for_runners_ynh) +[![for_runners_ynh @ PyPi](https://img.shields.io/pypi/v/for_runners_ynh?label=for_runners_ynh%20%40%20PyPi)](https://pypi.org/project/for_runners_ynh/) +[![Python Versions](https://img.shields.io/pypi/pyversions/for_runners_ynh)](https://github.com/YunoHost-Apps/django-for-runners_ynh/blob/main/pyproject.toml) +[![License GPL-3.0-or-later](https://img.shields.io/pypi/l/for_runners_ynh)](https://github.com/YunoHost-Apps/django-for-runners_ynh/blob/main/LICENSE) [django-for-runners](https://github.com/jedie/django-for-runners) is a libre web-based management for your GPX tracks of your running (or other sports activity). Used [Python](https://www.python.org/)/[Django](https://www.djangoproject.com/). - -[![pytest](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/pytest.yml/badge.svg?branch=master)](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/pytest.yml) [![YunoHost apps package linter](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/package_linter.yml/badge.svg)](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/package_linter.yml) [![Coverage Status on codecov.io](https://codecov.io/gh/YunoHost-Apps/django-for-runners_ynh/branch/master/graph/badge.svg)](https://codecov.io/gh/YunoHost-Apps/django-for-runners_ynh) - -![django-for-runners @ PyPi](https://img.shields.io/pypi/v/django-for-runners?label=django-for-runners%20%40%20PyPi) -![Python Versions](https://img.shields.io/pypi/pyversions/django-for-runners) -![License GPL V3+](https://img.shields.io/pypi/l/django-for-runners) - Pull requests welcome ;) This package for YunoHost used [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration) @@ -42,165 +39,8 @@ More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-r ![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) ![Captura de pantalla de django-for-runners](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) -## Avisos / información importante - -## Settings and upgrades - -Almost everything related to django-for-runners's configuration is handled in a `"../conf/settings.py"` file. -You can edit the file `/opt/yunohost/django-for-runners/local_settings.py` to enable or disable features. - -Test sending emails: - -```bash -ssh admin@yourdomain.tld -root@yunohost:~# cd /opt/yunohost/django-for-runners/ -root@yunohost:/opt/yunohost/django-for-runners# source venv/bin/activate -(venv) root@yunohost:/opt/yunohost/django-for-runners# ./manage.py sendtestemail --admins -``` - -Background info: Error mails are send to all [settings.ADMINS](https://docs.djangoproject.com/en/2.2/ref/settings/#std:setting-ADMINS). By default the YunoHost admin is inserted here. -To check current ADMINS run: - -```bash -(venv) root@yunohost:/opt/yunohost/django-for-runners# ./manage.py sendtestemail --admins -``` - -If you prefere to send error emails to a extrnal email address, just do something like this: - -```bash -echo "ADMINS = (('Your Name', 'example@domain.tld'),)" >> /opt/yunohost/django-for-runners/local_settings.py -``` - -To check the effective settings, run this: -```bash -(venv) root@yunohost:/opt/yunohost/django-for-runners# ./manage.py diffsettings -``` - - -# Miscellaneous - - -## SSO authentication - -[SSOwat](https://github.com/YunoHost/SSOwat) is fully supported via [django_ynh](https://github.com/YunoHost-Apps/django_ynh): - -* First user (`$YNH_APP_ARG_ADMIN`) will be created as Django's super user -* All new users will be created as normal users -* Login via SSO is fully supported -* User Email, First / Last name will be updated from SSO data - - -## Links - - * Report a bug about this package: https://github.com/YunoHost-Apps/django-for-runners_ynh - * Report a bug about django-for-runners itself: https://github.com/jedie/django-for-runners - * YunoHost website: https://yunohost.org/ - ---- - -# Developer info - -## package installation / debugging - -Please send your pull request to https://github.com/YunoHost-Apps/django-for-runners_ynh - -Try 'main' branch, e.g.: -```bash -sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/master --debug -or -sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/master --debug -``` - -Try 'testing' branch, e.g.: -```bash -sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug -or -sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug -``` - -To remove call e.g.: -```bash -sudo yunohost app remove django-for-runners -``` - -Backup / remove / restore cycle, e.g.: -```bash -yunohost backup create --apps django-for-runners -yunohost backup list -archives: - - django-for-runners-pre-upgrade1 - - 20201223-163434 -yunohost app remove django-for-runners -yunohost backup restore 20201223-163434 --apps django-for-runners -``` - -Debug installation, e.g.: -```bash -root@yunohost:~# ls -la /var/www/django-for-runners/ -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-for-runners/ -total 58 -drwxr-xr-x 5 django-for-runners django-for-runners 11 Dec 8 08:39 . -drwxr-xr-x 3 root root 3 Dec 8 08:36 .. --rw-r--r-- 1 django-for-runners django-for-runners 460 Dec 8 08:39 gunicorn.conf.py --rw-r--r-- 1 django-for-runners django-for-runners 0 Dec 8 08:39 local_settings.py --rwxr-xr-x 1 django-for-runners django-for-runners 274 Dec 8 08:39 manage.py --rw-r--r-- 1 django-for-runners django-for-runners 171 Dec 8 08:39 secret.txt -drwxr-xr-x 6 django-for-runners django-for-runners 6 Dec 8 08:37 venv --rw-r--r-- 1 django-for-runners django-for-runners 115 Dec 8 08:39 wsgi.py --rw-r--r-- 1 django-for-runners django-for-runners 4737 Dec 8 08:39 settings.py - -root@yunohost:~# cd /opt/yunohost/django-for-runners/ -root@yunohost:/opt/yunohost/django-for-runners# source venv/bin/activate -(venv) root@yunohost:/opt/yunohost/django-for-runners# ./manage.py check -django-for-runners v0.8.2 (Django v2.2.17) -DJANGO_SETTINGS_MODULE='settings' -PROJECT_PATH:/opt/yunohost/django-for-runners/venv/lib/python3.7/site-packages -BASE_PATH:/opt/yunohost/django-for-runners -System check identified no issues (0 silenced). - -root@yunohost:~# tail -f /var/log/django-for-runners/django-for-runners.log -root@yunohost:~# cat /etc/systemd/system/django-for-runners.service - -root@yunohost:~# systemctl reload-or-restart django-for-runners -root@yunohost:~# systemctl status django-for-runners -root@yunohost:~# journalctl --unit=for_runners --follow -``` - -## local test - -For quicker developing of django-for-runners 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-for-runners_ynh.git -~$ cd django-for-runners_ynh/ -~/django-for-runners_ynh$ make -install-poetry install or update poetry -install install django-for-runners via poetry -update update the sources and installation -local-test Run local_test.py to run django-for-runners_ynh locally -~/django-for-runners_ynh$ make install-poetry -~/django-for-runners_ynh$ make install -~/django-for-runners_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/` - ## Documentación e recursos -- Web oficial da app: - Documentación oficial para usuarias: - Documentación oficial para admin: - Repositorio de orixe do código: diff --git a/README_zh_Hans.md b/README_zh_Hans.md new file mode 100644 index 0000000..75708e5 --- /dev/null +++ b/README_zh_Hans.md @@ -0,0 +1,62 @@ + + +# YunoHost 上的 django-for-runners + +[![集成程度](https://dash.yunohost.org/integration/django-for-runners.svg)](https://dash.yunohost.org/appci/app/django-for-runners) ![工作状态](https://ci-apps.yunohost.org/ci/badges/django-for-runners.status.svg) ![维护状态](https://ci-apps.yunohost.org/ci/badges/django-for-runners.maintain.svg) + +[![使用 YunoHost 安装 django-for-runners](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-for-runners) + +*[阅读此 README 的其它语言版本。](./ALL_README.md)* + +> *通过此软件包，您可以在 YunoHost 服务器上快速、简单地安装 django-for-runners。* +> *如果您还没有 YunoHost，请参阅[指南](https://yunohost.org/install)了解如何安装它。* + +## 概况 + +[![tests](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/YunoHost-Apps/django-for-runners_ynh/actions/workflows/tests.yml) +[![codecov](https://codecov.io/github/jedie/for_runners_ynh/branch/main/graph/badge.svg)](https://app.codecov.io/github/jedie/for_runners_ynh) +[![for_runners_ynh @ PyPi](https://img.shields.io/pypi/v/for_runners_ynh?label=for_runners_ynh%20%40%20PyPi)](https://pypi.org/project/for_runners_ynh/) +[![Python Versions](https://img.shields.io/pypi/pyversions/for_runners_ynh)](https://github.com/YunoHost-Apps/django-for-runners_ynh/blob/main/pyproject.toml) +[![License GPL-3.0-or-later](https://img.shields.io/pypi/l/for_runners_ynh)](https://github.com/YunoHost-Apps/django-for-runners_ynh/blob/main/LICENSE) + +[django-for-runners](https://github.com/jedie/django-for-runners) is a libre web-based management for your GPX tracks of your running (or other sports activity). Used [Python](https://www.python.org/)/[Django](https://www.djangoproject.com/). + +Pull requests welcome ;) + +This package for YunoHost used [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration) + +More screenshots are here: [jedie.github.io/tree/master/screenshots/django-for-runners](https://github.com/jedie/jedie.github.io/tree/master/screenshots/django-for-runners/README.creole) + + +**分发版本：** 0.17.4~ynh1 + +## 截图 + +![django-for-runners 的截图](./doc/screenshots/for_runers_v060_2018_07_31_gpx_track.png) +![django-for-runners 的截图](./doc/screenshots/for_runners_v060_2018_07_19_event_costs.png) +![django-for-runners 的截图](./doc/screenshots/for_runners_v040_2018_6_26_gpx_info.png) + +## 文档与资源 + +- 官方用户文档： +- 官方管理文档： +- 上游应用代码库： +- YunoHost 商店： +- 报告 bug： + +## 开发者信息 + +请向 [`testing` 分支](https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing) 发送拉取请求。 + +如要尝试 `testing` 分支，请这样操作： + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug +或 +sudo yunohost app upgrade django-for-runners -u https://github.com/YunoHost-Apps/django-for-runners_ynh/tree/testing --debug +``` + +**有关应用打包的更多信息：**