Skip to main content

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 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

Project details


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.3b0.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

buzz_client-1.0.3b0-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file buzz_client-1.0.3b0.tar.gz.

File metadata

  • Download URL: buzz_client-1.0.3b0.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.1 Darwin/23.4.0

File hashes

Hashes for buzz_client-1.0.3b0.tar.gz
Algorithm Hash digest
SHA256 4da01d07833dfdff10a406b3aa2a2ea38690aae1905185b8a710c994297c3cea
MD5 7966ec92a518d19b184f7451f61d0f4a
BLAKE2b-256 32f4dc12adae47ac2518f6ea60c6efb81ea052e39a3404d6979efcb9962f9b62

See more details on using hashes here.

File details

Details for the file buzz_client-1.0.3b0-py3-none-any.whl.

File metadata

  • Download URL: buzz_client-1.0.3b0-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

Hashes for buzz_client-1.0.3b0-py3-none-any.whl
Algorithm Hash digest
SHA256 f83734637d8fb50726208ed1b2f3f4e30af965afeba766011faf6d99d6b44012
MD5 cbff1932e0ba3289ec39577d8d4d2ea9
BLAKE2b-256 45b994da231472f68c952a3460309e286ed05b8f1f18b0722b31ea5303a72cb9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page