{
"info": {
"author": "Nolan Conaway",
"author_email": "nolanbconaway@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Operating System :: MacOS",
"Operating System :: POSIX",
"Operating System :: Unix",
"Programming Language :: Python :: 2.7",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7"
],
"description": "# shlack\n\n[](https://github.com/nolanbconaway/shlack/actions)\n[](https://codecov.io/gh/nolanbconaway/shlack)\n[](https://pypi.org/project/shlack/)\n[](https://pypi.org/project/shlack/)\n\nshlack is a command line tool which sends slack messages. It is a lot like [jarjar](https://github.com/AusterweilLab/jarjar) but with [a few (important?) differences](shlack-and-jarjar.md).\n\n## Quickstart\n\nFirst, [set up a slack app](#setting-up-a-slack-app) for shlack and have the oauth API token handy.\n\nThen install shlack to your python 2.7, 3.5, 3.6, or 3.7 environment:\n\n``` sh\npip install shlack\n```\n\nOr\n\n``` sh\npip install git+https://github.com/nolanbconaway/shlack.git\n```\n\nExport your slack oauth token:\n\n``` sh\n$ export SLACK_OAUTH_API_TOKEN='...'\n```\n\nNow send yourself a message! shlack will read your token from the variable you exported.\n\n``` sh\n$ shlack message 'Hello!' --channel '@nolan'\n```\n\nIn your slack workspace:\n\n
\n\nshlack can also send you a notification after a long-running task has completed.\n\n``` sh\n$ shlack task 'sleep 10 && echo done' --channel '@nolan'\n```\n\n
\n \n
\n\nRunning that will spin up a process detached from your terminal session, so you can grab some lunch :-).\n\nNeed help? Just ask:\n\n``` sh\n$ shlack task --help\n```\n\n## Setting up a Slack App\n\nStart by heading over to the [apps page](https://api.slack.com/apps) and hit the \"create new app\" button.\n\nName your app whatever you want (I called mine, `shlack` ) and assign it to your workspace of choice if you have multiple workspaces. Then hit \"create app\".\n\nSlack should take you to an app management page. Hit the \"Permissions\" button (or the \"OAuth & Permissions\" tab on the sidebar).\n\nScroll down to the \"Scopes\" section. Add the following two scopes:\n\n1. `chat:write:bot` . Shlack needs this to post messages.\n2. `files:write:user` . Shlack needs this to upload files when e.g., your task output is very long.\n\nHit the \"Save Changes\" button once those two scopes are selected. Then scroll to the top of the page and hit the \"Install App to Workspace\" button. Slack will ask you to allow the app to access the scopes you set up.\n\nThe page will refresh and at the top you'll find a new OAuth Access Token. Copy that and put it somewhere for later.\n\nNow you can style the app as you see fit :). Hit the \"Basic Information\" tab at the top of the sidebar and scroll down to the \"Display Information\" section. Style to your liking. I use this photo which I found by searching \"dog with cowboy hat\" on the internet.\n\n
![](\"img/hello.png\")
\n![](\"img/hello_with_attach.png\")
\n![](\"img/sleep_10.png\")
\n
\n