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> [--title <title>] [--severity <severity>] [--attach <file>] [<body>...]
buzz --version
Options:
<notifier> the notifier you want to use,
you can see the available notifiers using `list` command
<recipient> the recipient of the notification,
must be valid for the notifier chosen
-h --help show this help message and exit
-v --version show version and exit
-a URL --api=URL API URL
--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
--format <format> format of the message text [default: text]
One of: 'text', 'markdown', 'html'
<body> Content of the notification,
if not specified read from stdin
Environment variables:
- BUZZ_API API URL, overrides command line argument
API URL format is `http(s)://auth-token@server`
Example: http://sesame@localhost:8000
- 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.4b0.tar.gz
(3.9 kB
view details)
Built Distribution
File details
Details for the file buzz_client-1.0.4b0.tar.gz.
File metadata
- Download URL: buzz_client-1.0.4b0.tar.gz
- Upload date:
- Size: 3.9 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 | 6273ad739c31dd3d5345c03862746e6c16591b6bf4903c8c0c66d5fb46eff425 |
|
| MD5 | c060c9c6d6d04656e3a6022e3bfa112a |
|
| BLAKE2b-256 | 68f0a564d0617a0fa01d6c441cc828879850a2f56e058ae990f98a69049180b3 |
File details
Details for the file buzz_client-1.0.4b0-py3-none-any.whl.
File metadata
- Download URL: buzz_client-1.0.4b0-py3-none-any.whl
- Upload date:
- Size: 5.3 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 | b10e77cdda8e0135328d14319d6781aeac83527e7b29ab64a9be6b7406e40ded |
|
| MD5 | 3124b7e627df0c33cec551ef8d2cbdc0 |
|
| BLAKE2b-256 | 96644ae32658e71ca44ae4ce6a1a12f1cc802ef481f8d1f167164c4f0a2ec222 |
