= slack-report
Report the results of executing the specified command to Slack.
== Use
The basic interface of `slack-report` is the same as `sudo`, `time`, `watch`, _etc._:
slack-report COMMAND
Any executable command, as well as its arguments, are accepted, and executed.
For example:
slack-report --channel=ops --title="uptime report" time annotate ./tps-reports.sh
The above would execute `time` (most likely `/usr/bin/time`), passing it the arguments `annotate ./tps-reports.sh` (such that these would be executed as well). The resulting standard output and error would be uploaded to Slack, and shared in the "ops" channel, with the title: "uptime report."
For the complete interface, consult `slack-report --help`.
== Installation
`slack-report` is available from https://pypi.org/project/slack-report/[PyPI] and https://github.com/dssg/slack-report[GitHub].
To install via `pip`:
pip install slack-report
== Configuration
In addition to its command flags, `slack-report` may be configured via the shell/process environment.
A Slack API token is *required*. This may be provided either via command flag `--token` or environment variable `SLACK_API_TOKEN`.
The API token requires permission:
* to post the results file: `files:write`
* to look up requested channels by name: `channels.read`
1 maintainer
Metadata
1 maintainer
Release files for slack-report 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| slack-report-0.1.0.tar.gz | 5.2 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| slack_report-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.9 kB
Release files / slack-report-0.1.0.tar.gz
| Download URL | slack-report-0.1.0.tar.gz |
|---|---|
| Size | 5.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
658d15f6246663021061e59bb5315ee95201318edd313a7b661744211e5c5e6d
|
|
BLAKE2b-256 checksum How to use checksums |
9c9878b31f646175761db0edbf39b7aedb7dd53776e5e1a9072cc54b17a02301
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.8.2 requests/2.27.1 setuptools/58.1.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
|
Release files / slack_report-0.1.0-py3-none-any.whl
| Download URL | slack_report-0.1.0-py3-none-any.whl |
|---|---|
| Size | 5.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
aefcdf1fc4893b0f1cf9b436c9ae4d64202b99ba77deac31e1a3c3a5f00f29aa
|
|
BLAKE2b-256 checksum How to use checksums |
7b5d21afeb3974de1018be0d1504fb967e59752fd567888b29d3ce5097214a67
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.8.2 requests/2.27.1 setuptools/58.1.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
|
Security for slack-report 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
