A client for Buzz API
Project description
buzz_client
A client for buzzAPI
Intro
buzz is a client for buzzAPI, 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
buzzlike
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
buzz_client-1.0.3.tar.gz
(3.6 kB
view details)
Built Distribution
File details
Details for the file buzz_client-1.0.3.tar.gz.
File metadata
- Download URL: buzz_client-1.0.3.tar.gz
- Upload date:
- Size: 3.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.1 Darwin/23.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d73464f3540dd16fb17878360cebedd23db5c328ac8abb3b5acc19033dbc1e5b |
|
| MD5 | a702d4d7ee3e6acaeec769147a793809 |
|
| BLAKE2b-256 | 10a6672ef1f06a4e9ebc0f312d351a748beaeeaeb6c38d75a2e11cda314b5fc8 |
File details
Details for the file buzz_client-1.0.3-py3-none-any.whl.
File metadata
- Download URL: buzz_client-1.0.3-py3-none-any.whl
- Upload date:
- Size: 4.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.1 Darwin/23.4.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e71ed2f9b3096dc1d19689e4926119c3b0f354905c9ea8e8c7e84f3bb732a9b7 |
|
| MD5 | c29198fe28e5a5ce5994571a7a9d5beb |
|
| BLAKE2b-256 | 6c970077d403ef676b9ef3da27bb0a63bea429397566ccc99a4987f38330e89f |
