diff --git a/README.md b/README.md index e69de29..cbb203a 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,220 @@ + + +# PyInventory for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/pyinventory.svg)](https://dash.yunohost.org/appci/app/pyinventory) ![Working status](https://ci-apps.yunohost.org/ci/badges/pyinventory.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/pyinventory.maintain.svg) +[![Install PyInventory with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pyinventory) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install PyInventory 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 + +[PyInventory](https://github.com/jedie/PyInventory) is a libre web-based management to catalog things including state and location etc. using [Python](https://www.python.org/)/[Django](https://www.djangoproject.com/). + +[![Integration level](https://dash.yunohost.org/integration/pyinventory.svg)](https://dash.yunohost.org/appci/app/pyinventory) [![CI Pipeline](https://ci-apps.yunohost.org/ci/badges/pyinventory.status.svg)](https://ci-apps.yunohost.org/ci/apps/pyinventory/) [![Maintain status](https://ci-apps.yunohost.org/ci/badges/pyinventory.maintain.svg)](https://dash.yunohost.org/appci/app/pyinventory) + +[![pytest](https://github.com/YunoHost-Apps/pyinventory_ynh/actions/workflows/pytest.yml/badge.svg?branch=master)](https://github.com/YunoHost-Apps/pyinventory_ynh/actions/workflows/pytest.yml) [![YunoHost apps package linter](https://github.com/YunoHost-Apps/pyinventory_ynh/actions/workflows/package_linter.yml/badge.svg)](https://github.com/YunoHost-Apps/pyinventory_ynh/actions/workflows/package_linter.yml) [![Coverage Status on codecov.io](https://codecov.io/gh/YunoHost-Apps/pyinventory_ynh/branch/master/graph/badge.svg)](https://codecov.io/gh/YunoHost-Apps/pyinventory_ynh) + +![pyinventory @ PyPi](https://img.shields.io/pypi/v/pyinventory?label=pyinventory%20%40%20PyPi) +![Python Versions](https://img.shields.io/pypi/pyversions/pyinventory) +![License GPL V3+](https://img.shields.io/pypi/l/pyinventory) + +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/PyInventory + + +**Shipped version:** 0.16.0rc1~ynh1 + + +## Screenshots + +![Screenshot of PyInventory](./doc/screenshots/pyinventory_v010_screenshot_2.png) +![Screenshot of PyInventory](./doc/screenshots/pyinventory_v010_screenshot_3.png) +![Screenshot of PyInventory](./doc/screenshots/pyinventory_v020_screenshot_1.png) +![Screenshot of PyInventory](./doc/screenshots/pyinventory_v0110_screenshot_memo_1.png) +![Screenshot of PyInventory](./doc/screenshots/gitkeep) + +## Disclaimers / important information + +## Settings and upgrades + +Almost everything related to PyInventory's configuration is handled in a `"../conf/settings.py"` file. +You can edit the file `/opt/yunohost/pyinventory/local_settings.py` to enable or disable features. + +Test sending emails: + +```bash +ssh admin@yourdomain.tld +root@yunohost:~# cd /opt/yunohost/pyinventory/ +root@yunohost:/opt/yunohost/pyinventory# source venv/bin/activate +(venv) root@yunohost:/opt/yunohost/pyinventory# ./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/pyinventory# ./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/pyinventory/local_settings.py +``` + +To check the effective settings, run this: +```bash +(venv) root@yunohost:/opt/yunohost/pyinventory# ./manage.py diffsettings +``` + + +# Miscellaneous + + +## SSO authentication + +[SSOwat](https://github.com/YunoHost/SSOwat) is fully supported via [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration): + +* 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/pyinventory_ynh + * Report a bug about PyInventory itself: https://github.com/jedie/PyInventory + * YunoHost website: https://yunohost.org/ + +--- + +# Developer info + +## package installation / debugging + +Please send your pull request to https://github.com/YunoHost-Apps/pyinventory_ynh + +Try 'main' branch, e.g.: +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/pyinventory_ynh/tree/master --debug +or +sudo yunohost app upgrade pyinventory -u https://github.com/YunoHost-Apps/pyinventory_ynh/tree/master --debug +``` + +Try 'testing' branch, e.g.: +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/pyinventory_ynh/tree/testing --debug +or +sudo yunohost app upgrade pyinventory -u https://github.com/YunoHost-Apps/pyinventory_ynh/tree/testing --debug +``` + +To remove call e.g.: +```bash +sudo yunohost app remove pyinventory +``` + +Backup / remove / restore cycle, e.g.: +```bash +yunohost backup create --apps pyinventory +yunohost backup list +archives: + - pyinventory-pre-upgrade1 + - 20201223-163434 +yunohost app remove pyinventory +yunohost backup restore 20201223-163434 --apps pyinventory +``` + +Debug installation, e.g.: +```bash +root@yunohost:~# ls -la /var/www/pyinventory/ +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/pyinventory/ +total 58 +drwxr-xr-x 5 pyinventory pyinventory 11 Dec 8 08:39 . +drwxr-xr-x 3 root root 3 Dec 8 08:36 .. +-rw-r--r-- 1 pyinventory pyinventory 460 Dec 8 08:39 gunicorn.conf.py +-rw-r--r-- 1 pyinventory pyinventory 0 Dec 8 08:39 local_settings.py +-rwxr-xr-x 1 pyinventory pyinventory 274 Dec 8 08:39 manage.py +-rw-r--r-- 1 pyinventory pyinventory 171 Dec 8 08:39 secret.txt +drwxr-xr-x 6 pyinventory pyinventory 6 Dec 8 08:37 venv +-rw-r--r-- 1 pyinventory pyinventory 115 Dec 8 08:39 wsgi.py +-rw-r--r-- 1 pyinventory pyinventory 4737 Dec 8 08:39 settings.py + +root@yunohost:~# cd /opt/yunohost/pyinventory/ +root@yunohost:/opt/yunohost/pyinventory# source venv/bin/activate +(venv) root@yunohost:/opt/yunohost/pyinventory# ./manage.py check +PyInventory v0.8.2 (Django v2.2.17) +DJANGO_SETTINGS_MODULE='settings' +PROJECT_PATH:/opt/yunohost/pyinventory/venv/lib/python3.7/site-packages +BASE_PATH:/opt/yunohost/pyinventory +System check identified no issues (0 silenced). + +root@yunohost:~# tail -f /var/log/pyinventory/pyinventory.log +root@yunohost:~# cat /etc/systemd/system/pyinventory.service + +root@yunohost:~# systemctl reload-or-restart pyinventory +root@yunohost:~# journalctl --unit=pyinventory --follow +``` + +## local test + +For quicker developing of PyInventory 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/pyinventory_ynh.git +~$ cd pyinventory_ynh/ +~/pyinventory_ynh$ make +install-poetry install or update poetry +install install PyInventory via poetry +update update the sources and installation +local-test Run local_test.py to run pyinventory_ynh locally +~/pyinventory_ynh$ make install-poetry +~/pyinventory_ynh$ make install +~/pyinventory_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/` + +## Documentation and resources + +* Official app website: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/pyinventory_ynh/tree/testing). + +To try the testing branch, please proceed like that. + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/pyinventory_ynh/tree/testing --debug +or +sudo yunohost app upgrade pyinventory -u https://github.com/YunoHost-Apps/pyinventory_ynh/tree/testing --debug +``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..2027178 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,220 @@ + + +# PyInventory pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/pyinventory.svg)](https://dash.yunohost.org/appci/app/pyinventory) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/pyinventory.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/pyinventory.maintain.svg) +[![Installer PyInventory avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pyinventory) + +*[Read this readme in english.](./README.md)* + +> *Ce package vous permet d'installer PyInventory 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.* + +## Vue d'ensemble + +[PyInventory](https://github.com/jedie/PyInventory) is a libre web-based management to catalog things including state and location etc. using [Python](https://www.python.org/)/[Django](https://www.djangoproject.com/). + +[![Integration level](https://dash.yunohost.org/integration/pyinventory.svg)](https://dash.yunohost.org/appci/app/pyinventory) [![CI Pipeline](https://ci-apps.yunohost.org/ci/badges/pyinventory.status.svg)](https://ci-apps.yunohost.org/ci/apps/pyinventory/) [![Maintain status](https://ci-apps.yunohost.org/ci/badges/pyinventory.maintain.svg)](https://dash.yunohost.org/appci/app/pyinventory) + +[![pytest](https://github.com/YunoHost-Apps/pyinventory_ynh/actions/workflows/pytest.yml/badge.svg?branch=master)](https://github.com/YunoHost-Apps/pyinventory_ynh/actions/workflows/pytest.yml) [![YunoHost apps package linter](https://github.com/YunoHost-Apps/pyinventory_ynh/actions/workflows/package_linter.yml/badge.svg)](https://github.com/YunoHost-Apps/pyinventory_ynh/actions/workflows/package_linter.yml) [![Coverage Status on codecov.io](https://codecov.io/gh/YunoHost-Apps/pyinventory_ynh/branch/master/graph/badge.svg)](https://codecov.io/gh/YunoHost-Apps/pyinventory_ynh) + +![pyinventory @ PyPi](https://img.shields.io/pypi/v/pyinventory?label=pyinventory%20%40%20PyPi) +![Python Versions](https://img.shields.io/pypi/pyversions/pyinventory) +![License GPL V3+](https://img.shields.io/pypi/l/pyinventory) + +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/PyInventory + + +**Version incluse :** 0.16.0rc1~ynh1 + + +## Captures d'écran + +![Capture d'écran de PyInventory](./doc/screenshots/pyinventory_v010_screenshot_2.png) +![Capture d'écran de PyInventory](./doc/screenshots/pyinventory_v010_screenshot_3.png) +![Capture d'écran de PyInventory](./doc/screenshots/pyinventory_v020_screenshot_1.png) +![Capture d'écran de PyInventory](./doc/screenshots/pyinventory_v0110_screenshot_memo_1.png) +![Capture d'écran de PyInventory](./doc/screenshots/gitkeep) + +## Avertissements / informations importantes + +## Settings and upgrades + +Almost everything related to PyInventory's configuration is handled in a `"../conf/settings.py"` file. +You can edit the file `/opt/yunohost/pyinventory/local_settings.py` to enable or disable features. + +Test sending emails: + +```bash +ssh admin@yourdomain.tld +root@yunohost:~# cd /opt/yunohost/pyinventory/ +root@yunohost:/opt/yunohost/pyinventory# source venv/bin/activate +(venv) root@yunohost:/opt/yunohost/pyinventory# ./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/pyinventory# ./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/pyinventory/local_settings.py +``` + +To check the effective settings, run this: +```bash +(venv) root@yunohost:/opt/yunohost/pyinventory# ./manage.py diffsettings +``` + + +# Miscellaneous + + +## SSO authentication + +[SSOwat](https://github.com/YunoHost/SSOwat) is fully supported via [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration): + +* 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/pyinventory_ynh + * Report a bug about PyInventory itself: https://github.com/jedie/PyInventory + * YunoHost website: https://yunohost.org/ + +--- + +# Developer info + +## package installation / debugging + +Please send your pull request to https://github.com/YunoHost-Apps/pyinventory_ynh + +Try 'main' branch, e.g.: +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/pyinventory_ynh/tree/master --debug +or +sudo yunohost app upgrade pyinventory -u https://github.com/YunoHost-Apps/pyinventory_ynh/tree/master --debug +``` + +Try 'testing' branch, e.g.: +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/pyinventory_ynh/tree/testing --debug +or +sudo yunohost app upgrade pyinventory -u https://github.com/YunoHost-Apps/pyinventory_ynh/tree/testing --debug +``` + +To remove call e.g.: +```bash +sudo yunohost app remove pyinventory +``` + +Backup / remove / restore cycle, e.g.: +```bash +yunohost backup create --apps pyinventory +yunohost backup list +archives: + - pyinventory-pre-upgrade1 + - 20201223-163434 +yunohost app remove pyinventory +yunohost backup restore 20201223-163434 --apps pyinventory +``` + +Debug installation, e.g.: +```bash +root@yunohost:~# ls -la /var/www/pyinventory/ +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/pyinventory/ +total 58 +drwxr-xr-x 5 pyinventory pyinventory 11 Dec 8 08:39 . +drwxr-xr-x 3 root root 3 Dec 8 08:36 .. +-rw-r--r-- 1 pyinventory pyinventory 460 Dec 8 08:39 gunicorn.conf.py +-rw-r--r-- 1 pyinventory pyinventory 0 Dec 8 08:39 local_settings.py +-rwxr-xr-x 1 pyinventory pyinventory 274 Dec 8 08:39 manage.py +-rw-r--r-- 1 pyinventory pyinventory 171 Dec 8 08:39 secret.txt +drwxr-xr-x 6 pyinventory pyinventory 6 Dec 8 08:37 venv +-rw-r--r-- 1 pyinventory pyinventory 115 Dec 8 08:39 wsgi.py +-rw-r--r-- 1 pyinventory pyinventory 4737 Dec 8 08:39 settings.py + +root@yunohost:~# cd /opt/yunohost/pyinventory/ +root@yunohost:/opt/yunohost/pyinventory# source venv/bin/activate +(venv) root@yunohost:/opt/yunohost/pyinventory# ./manage.py check +PyInventory v0.8.2 (Django v2.2.17) +DJANGO_SETTINGS_MODULE='settings' +PROJECT_PATH:/opt/yunohost/pyinventory/venv/lib/python3.7/site-packages +BASE_PATH:/opt/yunohost/pyinventory +System check identified no issues (0 silenced). + +root@yunohost:~# tail -f /var/log/pyinventory/pyinventory.log +root@yunohost:~# cat /etc/systemd/system/pyinventory.service + +root@yunohost:~# systemctl reload-or-restart pyinventory +root@yunohost:~# journalctl --unit=pyinventory --follow +``` + +## local test + +For quicker developing of PyInventory 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/pyinventory_ynh.git +~$ cd pyinventory_ynh/ +~/pyinventory_ynh$ make +install-poetry install or update poetry +install install PyInventory via poetry +update update the sources and installation +local-test Run local_test.py to run pyinventory_ynh locally +~/pyinventory_ynh$ make install-poetry +~/pyinventory_ynh$ make install +~/pyinventory_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/` + +## Documentations et ressources + +* Site officiel de l'app : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/pyinventory_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/pyinventory_ynh/tree/testing --debug +ou +sudo yunohost app upgrade pyinventory -u https://github.com/YunoHost-Apps/pyinventory_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :**