Metadata-Version: 2.1
Name: fritznagios
Version: 0.1.2
Summary: Nagios/Icinga monitoring check program for FRITZ!Box devices
Home-page: https://github.com/cicerops/fritznagios
Author: Jan Hoffmann
Author-email: jan.hoffmann@cicerops.de
License: MIT
Keywords: FRITZ!Box,AVM,fritzbox,fritz,Nagios,Icinga,monitoring,TR-064,UPnP
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: Communications
Classifier: Topic :: Database
Classifier: Topic :: Internet
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Archiving
Classifier: Topic :: System :: Logging
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
Requires-Python: >=3.4
Description-Content-Type: text/markdown
License-File: LICENSE

# Fritznagios

[![Status](https://img.shields.io/pypi/status/fritznagios.svg?style=flat-square)](https://pypi.org/project/fritznagios/)
[![License](https://img.shields.io/github/license/cicerops/fritznagios.svg?style=flat-square)](https://github.com/cicerops/fritznagios/blob/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/fritznagios.svg?style=flat-square)](https://pypi.org/project/fritznagios/)
[![Python versions](https://img.shields.io/pypi/pyversions/fritznagios.svg?style=flat-square)](https://pypi.org/project/fritznagios/)
[![Downloads](https://img.shields.io/pypi/dm/fritznagios.svg?style=flat-square)](https://pypi.org/project/fritznagios/)

## About

Nagios/Icinga monitoring check program for FRITZ!Box devices based on the
excellent [fritzconnection] module for maximum device coverage. It uses
the TR-064 protocol over [UPnP].

Icinga Exchange: https://exchange.icinga.com/tonke/fritznagios

[fritzconnection]: https://github.com/kbr/fritzconnection
[UPnP]: https://en.wikipedia.org/wiki/Universal_Plug_and_Play

## Setup

    python3 -m venv /opt/fritznagios

    # Install latest stable version.
    /opt/fritznagios/bin/pip install fritznagios

    # Install from repository.
    /opt/fritznagios/bin/pip install git+https://github.com/cicerops/fritznagios

## Usage

    /opt/fritznagios/bin/fritznagios --help

## Icinga 2

For integrating the check program into Icinga 2, you can use the
configuration files in the `icinga2` subdirectory. You can easily
acquire the files using:

    wget https://raw.githubusercontent.com/cicerops/fritznagios/main/icinga2/fritznagios-command.conf
    wget https://raw.githubusercontent.com/cicerops/fritznagios/main/icinga2/fritznagios-services.conf
    wget https://raw.githubusercontent.com/cicerops/fritznagios/main/icinga2/fritznagios-host.conf

## Development

Acquire sources:

    git clone https://github.com/cicerops/fritznagios
    cd fritznagios

Install program in development mode:

    python3 -m venv .venv
    source .venv/bin/activate
    pip install --editable=.

Build and upload sdist package to PyPI:

    python setup.py sdist
    pip install twine && twine upload --skip-existing dist/*


