Metadata-Version: 2.1
Name: buzz-client
Version: 1.0.3a0
Summary: A client for Buzz API
License: GPL
Author: Andrea Mistrali
Author-email: andrea@mistrali.pw
Requires-Python: >=3.10,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: docopt-ng (>=0.9.0,<0.10.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: scriptonite (>=1.0.3,<2.0.0)
Description-Content-Type: text/markdown

# buzz_client

A client for buzzAPI

## Intro

`buzz` is a client for [buzzAPI](https://git.arr.lan/gitroot/devops/apps/buzz-api), a tool to send notifications to several services, like email, pushover, slack, teams...

Syntax is:

```
Buzz client

Usage:
    buzz [options] list
    buzz [options] version
    buzz [options] send <notifier> --recipient <recipient> [--title <title>] [--severity <severity>] [--attach <file>] [<body>...]
    buzz --version


Options:
    -h  --help                   show this help message and exit
    -v --version                 show version and exit
    -s URL --server=URL          API URL
    -t TOKEN --token=TOKEN       API Auth token

    --recipient <recipient>      the recipient of the notification,
                                 must be valid for the notifier chosen
    --title <title>              the title of the notification. [default: You received a buzz]
    --severity <severity>        the severity of the message. [default: info]
                                 One of: 'info', 'success', 'warning', 'failure'
    --attach <file>              a file you want to attach to the notification

    <notifier>                   the notifier you want to use,
                                 you can see the available notifiers using `list` command

    <body>                       Content of the notification,
                                 if not specified read from stdin
Environment variables:
    - BC_API         API URL, overrides command line argument
    - BC_TOKEN       API token, overrides command line argument
```

- URL is the URL of the buzzAPI, for example https://buzz.domain.com/
- TOKEN is the authentication token of the buzzAPI instance.

The other arguments are quite self explicative, but you have to bear in mind that the body of the notification:

- can be passed on the command line of `buzz` like

```
buzz send email --recipient me@domain.com This is the content of the notification
```

- if not passed as an argument of `buzz`, then the content of the notification is read from standard input, for example

```
echo "Content of directory"; ls | buzz send --recipient me@domain.com
```

