Metadata-Version: 2.1
Name: ntfy-lite
Version: 1.0.0
Summary: minimalistic python API for sending ntfy notifications
Home-page: https://github.com/MPI-IS/ntfy_lite
License: BSD-3-Clause
Author: Vincent Berenz
Author-email: vberenz@tuebingen.mpg.de
Maintainer: Vincent Berenz
Maintainer-email: vberenz@tuebingen.mpg.de
Requires-Python: >=3.7,<4
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: pytest (>=7.1.3,<8.0.0)
Requires-Dist: requests (>=2.28.1,<3.0.0)
Requires-Dist: types-requests (>=2.28.11.2,<3.0.0.0)
Requires-Dist: validators (>=0.20.0,<0.21.0)
Project-URL: Repository, https://github.com/MPI-IS/ntfy_lite
Description-Content-Type: text/markdown

![unit tests](https://github.com/MPI-IS/ntfy_lite/actions/workflows/tests.yaml/badge.svg)
![mypy](https://github.com/MPI-IS/ntfy_lite/actions/workflows/python_mypy.yml/badge.svg)

# NTFY LITE

**ntfy_lite** is a minimalistic python API for sending [ntfy](https://ntfy.sh) notifications.

It comes with a **Handler** for the [logging package](https://docs.python.org/3/library/logging.html).


## Installation

from source:

```bash
git clone https://github.com/MPI-IS/ntfy_lite.git
cd ntfy_lite
pip install .
```

from pypi:
```bash
pip install ntfy_lite
```

## Usage

The two following examples cover the full API.
You may also find the code in the demos folder of the sources.

### pushing notifications

https://github.com/MPI-IS/ntfy_lite/blob/87eab776278686e5f58857c8caa76ac1d66813c9/demos/ntfy_push.py#L1-L71

### logging handler

https://github.com/MPI-IS/ntfy_lite/blob/87eab776278686e5f58857c8caa76ac1d66813c9/demos/ntfy_logging.py#L1-L146

## Limitation

No check regarding ntfy [limitations](https://ntfy.sh/docs/publish/#limitations) is performed before notifications are sent.

## Copyright

© 2020, Max Planck Society - Max Planck Institute for Intelligent Systems


