mirror of
https://github.com/YunoHost-Apps/pyinventory_ynh.git
synced 2024-09-03 20:16:09 +02:00
86 lines
4.4 KiB
Markdown
86 lines
4.4 KiB
Markdown
<!--
|
|
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.
|
|
-->
|
|
|
|
# PyInventory for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/pyinventory)  
|
|
|
|
[](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
|
|
|
|
[](https://github.com/YunoHost-Apps/pyinventory_ynh/actions/workflows/tests.yml)
|
|
[](https://app.codecov.io/github/jedie/pyinventory_ynh)
|
|
[](https://pypi.org/project/pyinventory_ynh/)
|
|
[](https://github.com/YunoHost-Apps/pyinventory_ynh/blob/main/pyproject.toml)
|
|
[](https://github.com/YunoHost-Apps/pyinventory_ynh/blob/main/LICENSE)
|
|
|
|
[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/).
|
|
|
|
[](https://dash.yunohost.org/appci/app/pyinventory_ynh)  
|
|
[](https://install-app.yunohost.org/?app=pyinventory_ynh)
|
|
|
|
|
|
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.19.3~ynh1
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 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 `/home/yunohost.app/django_example/local_settings.py` to enable or disable features.
|
|
|
|
Test sending emails, e.g.:
|
|
|
|
```bash
|
|
ssh admin@yourdomain.tld
|
|
root@yunohost:~# /home/yunohost.app/pyinventory/manage.py sendtestemail --admins
|
|
```
|
|
|
|
How to debug a django YunoHost app, take a look into:
|
|
|
|
* https://github.com/YunoHost-Apps/django_example_ynh#developer-info
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: <https://github.com/YunoHost-Apps/pyinventory_ynh>
|
|
* Official user documentation: <https://github.com/jedie/PyInventory>
|
|
* Official admin documentation: <https://github.com/YunoHost-Apps/pyinventory_ynh>
|
|
* Upstream app code repository: <https://github.com/YunoHost-Apps/pyinventory_ynh>
|
|
* YunoHost Store: <https://apps.yunohost.org/app/pyinventory>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/pyinventory_ynh/issues>
|
|
|
|
## 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:** <https://yunohost.org/packaging_apps>
|