Metadata-Version: 2.3
Name: mplugin
Version: 2.0.0a0
Summary: Class library for writing Nagios (Icinga) plugins
Keywords: Nagios,Icinga,plugin,check,monitoring
Author: Christian Kauhaus, Matthew Pounsett, Josef Friedrich
Author-email: Christian Kauhaus <kc@flyingcircus.io>, Matthew Pounsett <matt@conundrum.com>, Josef Friedrich <josef@friedrich.rocks>
License: ZPL-2.1
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Monitoring
Requires-Dist: typing-extensions>=4.15.0
Requires-Python: >=3.10
Project-URL: Documentation, https://mplugin.readthedocs.io/
Project-URL: Download, https://pypi.org/project/mplugin/
Project-URL: Source, https://github.com/Josef-Friedrich/mplugin
Project-URL: Issues, https://github.com/Josef-Friedrich/mplugin/issues
Project-URL: Changelog, https://github.com/Josef-Friedrich/mplugin/blob/main/HISTORY.txt
Description-Content-Type: text/x-rst

The mplugin library
============================

About
-----

**mplugin** is a Python class library which helps writing Nagios (or Icinga)
compatible plugins easily in Python. It cares for much of the boilerplate code
and default logic commonly found in Nagios checks, including:

- Nagios 3 Plugin API compliant parameters and output formatting
- Full Nagios range syntax support
- Automatic threshold checking
- Multiple independend measures
- Custom status line to communicate the main point quickly
- Long output and performance data
- Timeout handling
- Persistent "cookies" to retain state information between check runs
- Resume log file processing at the point where the last run left
- No dependencies beyond the Python standard library (except for Python 2.6).

**mplugin** runs on POSIX and Windows systems. It is compatible with
and Python 3.9 and later.

Feedback and Suggestions
------------------------

mplugin is currently maintained by Josef Friedrich <josef@friedrich.rocks>.  A
public issue tracker can be found at
<https://github.com/Josef-Friedrich/mplugin/issues> for bugs, suggestions, and
patches.

License
-------

The mplugin package is released under the Zope Public License 2.1 (ZPL), a
BSD-style Open Source license.


Documentation
-------------

Comprehensive documentation is `available online`_. The examples mentioned in
the `tutorials`_ can also be found in the `mplugin/examples` directory of
the source distribution.

.. _available online: https://mplugin.readthedocs.io/
.. _tutorials: https://mplugin.readthedocs.io/en/stable/tutorial/

Acknowledgements
----------------

mplugin was originally written and maintained by Christian Kauhaus
<kc@flyingcircus.io>.  Additional contributions from the community are
acknowledged in the file CONTRIBUTORS.txt

.. vim: set ft=rst:
