django-fritzconnection_ynh/README.md

60 lines
3.2 KiB
Markdown
Raw Normal View History

2022-04-02 20:41:54 +02:00
<!--
2024-03-28 22:18:52 +01:00
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
2022-04-02 20:41:54 +02:00
It shall NOT be edited by hand.
-->
2022-04-02 17:44:57 +02:00
2022-04-02 20:41:54 +02:00
# django-fritzconnection for YunoHost
2022-04-02 17:44:57 +02:00
2023-01-24 13:11:35 +01:00
[![Integration level](https://dash.yunohost.org/integration/django-fritzconnection.svg)](https://dash.yunohost.org/appci/app/django-fritzconnection) ![Working status](https://ci-apps.yunohost.org/ci/badges/django-fritzconnection.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/django-fritzconnection.maintain.svg)
2023-10-20 20:38:26 +02:00
2022-04-02 17:44:57 +02:00
[![Install django-fritzconnection with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=django-fritzconnection)
2024-05-20 16:21:59 +02:00
*[Read this README in other languages.](./ALL_README.md)*
2022-04-02 20:41:54 +02:00
2024-03-28 22:18:52 +01:00
> *This package allows you to install django-fritzconnection 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.*
2022-04-02 17:44:57 +02:00
2022-04-02 20:41:54 +02:00
## Overview
2022-04-08 18:15:31 +02:00
Web based FritzBox management using Python/Django and the great [fritzconnection](https://github.com/kbr/fritzconnection) library.
2022-04-02 20:41:54 +02:00
2022-04-08 18:15:31 +02:00
The basic idea is to block/unblock Internet access to a group of devices as easily as possible.
2022-04-08 18:09:57 +02:00
2022-04-02 20:41:54 +02:00
[![pytest](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/actions/workflows/pytest.yml/badge.svg?branch=master)](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/actions/workflows/pytest.yml) [![YunoHost apps package linter](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/actions/workflows/package_linter.yml/badge.svg)](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/actions/workflows/package_linter.yml) [![Coverage Status on codecov.io](https://codecov.io/gh/YunoHost-Apps/django-fritzconnection_ynh/branch/master/graph/badge.svg)](https://codecov.io/gh/YunoHost-Apps/django-fritzconnection_ynh)
2022-04-07 08:12:25 +02:00
![django-fritzconnection @ PyPi](https://img.shields.io/pypi/v/django-fritzconnection?label=django-fritzconnection%20%40%20PyPi)
![Python Versions](https://img.shields.io/pypi/pyversions/django-fritzconnection)
![License GPL V3+](https://img.shields.io/pypi/l/django-fritzconnection)
2022-04-02 17:44:57 +02:00
Pull requests welcome ;)
This package for YunoHost used [django-yunohost-integration](https://github.com/YunoHost-Apps/django_yunohost_integration)
2024-03-28 22:18:52 +01:00
**Shipped version:** 0.2.0~ynh3
2022-04-08 18:15:31 +02:00
## Screenshots
2023-01-24 13:13:59 +01:00
![Screenshot of django-fritzconnection](./doc/screenshots/screenshot.png)
2022-04-08 18:15:31 +02:00
2022-04-02 20:41:54 +02:00
## Documentation and resources
2024-03-28 22:18:52 +01:00
- Upstream app code repository: <https://github.com/jedie/django-fritzconnection>
- YunoHost Store: <https://apps.yunohost.org/app/django-fritzconnection>
- Report a bug: <https://github.com/YunoHost-Apps/django-fritzconnection_ynh/issues>
2022-04-02 20:41:54 +02:00
## Developer info
2024-03-28 22:18:52 +01:00
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing).
2022-04-02 20:41:54 +02:00
2024-03-28 22:18:52 +01:00
To try the `testing` branch, please proceed like that:
2022-10-04 17:52:53 +02:00
2024-03-28 22:18:52 +01:00
```bash
2022-04-02 20:41:54 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing --debug
or
sudo yunohost app upgrade django-fritzconnection -u https://github.com/YunoHost-Apps/django-fritzconnection_ynh/tree/testing --debug
```
2022-10-04 17:52:53 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>