<p align="center">
<img src="https://s3.amazonaws.com/assets.nickficano.com/slackcat.svg" height="64">
<h2 align="center">SlackCat</h3>
<p align="center">Concatenate files(s), or <code>stdin</code>, directly to Slack.<br>
3-minute setup & no third-party integration required.
<p align="center">
<a href="https://pypi.python.org/pypi/slackcat/"><img src="https://img.shields.io/pypi/pyversions/slackcat.svg" alt="pypi"></a>
<a href="https://pypi.python.org/pypi/slackcat/"><img src="https://img.shields.io/pypi/v/slackcat.svg" alt="pypi"></a>
<img src="https://img.shields.io/badge/pip_dependencies-0-brightgreen.svg" alt="pip dependencies">
</p>
</p>
### Get SlackCat
Download using pip via pypi.
```bash
pip install slackcat
```
Next, head to the [Slack Incoming WebHooks Configuration](https://slack.com/apps/A0F7XDUAZ-incoming-webhooks), click
the ``Add Configuration`` button and set the default configuration values to your
liking. Once complete, copy the Webhook URL which we'll need in the next step.
Open your ``~/.bash_profile`` file add following:
```bash
export SLACKCAT_WEBHOOK_URL="https://hooks.slack.com/services/TXXX/BXXXX/XXXXXXXXXXXXXXXXXXXXXXXX"
```
_Make sure to replace the "https://hooks.slack.com/services/..." with the one provided above._
### Usage
```bash
# - "Hey what's your public key dog?"
slackcat @doug ~/.ssh/id_rsa.pub
# - "Do we still use that crypto library written by the Cheese Cake Factory?"
grep -r 'from cheesecake.factory import x509' ./ | slackcat @paul
# - "Are you sure it's on your path?"
echo $PATH | slackcat "#general"
# - "These queries filling up in syslog look suspicious"
tail -f /var/log/syslog | slackcat "#general" -f
```
### Customization
If you would like to override the bot's username, add the following line to your ``~/.bash_profile`` file:
```bash
export SLACKCAT_USERNAME="abraham-linksys"
```
If you would like to override the bot's icon image, add the following line to your ``~/.bash_profile`` file:
```bash
export SLACKCAT_ICON_URL="http://via.placeholder.com/500x500.png"
```
### Development
Development of "SlackCat" is facilitated exclusively on GitHub. Contributions in the form of patches, tests and feature creation and/or requests are very welcome and highly encouraged. Please open an issue if this tool does not function as you'd expect.
**How to release updates**
If this is the first time you're releasing to pypi, you'll need to run: ``pip install -r tests/dev_requirements.txt``.
Once complete, execute the following commands:
```bash
git checkout master
# Increment the version number and tag the release.
bumpversion [major|minor|patch]
# Upload the distribution to PyPi
python setup.py sdist bdist_wheel upload
# Since master often contains work-in-progress changes, increment the version
# to a patch release to prevent inaccurate attribution.
bumpversion --no-tag patch
git push origin master --tags
```
Metadata
Release files for slackcat 2.0.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 | Actions |
|---|---|---|---|---|
| slackcat-2.0.0.tar.gz | 5.5 kB | Without provenance | Details for slackcat-2.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| slackcat-2.0.0-py3-none-any.whl | Python 3 | none | any | Details for slackcat-2.0.0-py3-none-any.whl |
Total release size: 15.4 kB
Release files / slackcat-2.0.0.tar.gz
| Download URL | slackcat-2.0.0.tar.gz |
|---|---|
| Size | 5.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
64c3accbb2484fa3cd1b1194f841ab1ade16150b630726095c511c5fec4e9459
|
|
BLAKE2b-256 checksum How to use checksums |
57bee0d76b0ba3d9df002da0943489a661882e3eee5456655f1aad6e65dd1815
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / slackcat-2.0.0-py3-none-any.whl
| Download URL | slackcat-2.0.0-py3-none-any.whl |
|---|---|
| Size | 9.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8489c6bd36f7f2ad772efd86fa854247afc164cd62434ab28dfd2c57f362e8f7
|
|
BLAKE2b-256 checksum How to use checksums |
7a7382e093b9ec6b0064f9235656aa47404364c1456123c4749676a04ec1da8f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for slackcat 2.0.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.
To learn more about protecting yourself from malicious actors, visit our package security documentation.