Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jlumbroso/slacktivate
Slacktivate allows you to automatically provision and manage a Slack workspace based on a YAML specification.
https://github.com/jlumbroso/slacktivate
python repl slack slack-api slackapi slackware
Last synced: 27 days ago
JSON representation
Slacktivate allows you to automatically provision and manage a Slack workspace based on a YAML specification.
- Host: GitHub
- URL: https://github.com/jlumbroso/slacktivate
- Owner: jlumbroso
- License: lgpl-3.0
- Created: 2020-08-24T00:32:42.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-10-05T04:24:04.000Z (about 2 years ago)
- Last Synced: 2024-11-17T00:06:46.226Z (about 1 month ago)
- Topics: python, repl, slack, slack-api, slackapi, slackware
- Language: Python
- Homepage: https://slacktivate.readthedocs.io
- Size: 364 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Slacktivate
[](https://codecov.io/gh/jlumbroso/slacktivate)
[](https://slacktivate.readthedocs.io/en/latest/?badge=latest)
[](https://pepy.tech/project/slacktivate)
[](https://github.com/jlumbroso/slacktivate)
Slacktivate is a Python library and Command-Line Interface
to assist in the provisioning and management of a Slack workspace, using
both the Slack API and the Slack SCIM API:
- Write a YAML specifications to describe your users, channels and groups,
then have Slacktivate set up your workspace with no manual intervention.
- Use the self-documented Slacktivate REPL to immediately do batch operations
on your Slack workspace and build new powerful macros.
- Robust, Pythonic wrapper to the Slack API and Slack SCIM API clients,
able to abstract some of the quirks of the API—as well as able to handle
typical error management (such as rate limiting) transparently.
- Find everything you need to be a Slack power user in one place, rather
than spread to a microcosm of evolving documentations.
## Installation
The package is available on PyPI as `slacktivate` and so is available the
usual way, i.e., `pip install slacktivate`; in addition to the Python package,
this should also install a CLI binary that is runnable, called `slacktivate`:
```
$ slacktivate --help
Usage: slacktivate [OPTIONS] COMMAND [ARGS]...
Options:
--token $SLACK_TOKEN Slack API token (requires being an owner or admin).
--spec SPEC Provide the specification for the Slack workspace.
-y, --dry-run Do not actually perform the action.
--version Show the version and exit.
--help Show this message and exit.
Commands:
list Lists any type of object defined in the provided specification...
repl A Python REPL with the Slacktivate package, and Slack clients...
users Sub-command for operations on Slack users (e.g.: activate,...
validate Validate the configuration file SPEC
```
## Specification Example
The following is an example of specification for a workspace, with the user
information (name, emails, perhaps additional profile information) stored here
in external CSV files:
```yaml
vars:
"TERM": "2020-Q4"
users:
- file: "input/{{ vars.TERM }}_managers*.csv"
sort: "newest"
type: "csv"
key: "{{ email }}"
fields:
"type": ["manager", "employee"]
# Slack normal fields
"givenName": "{{ first }}"
"familyName": "{{ last }}"
"userName": "{{ email.split('@')[0] }}"
- file: "input/{{ vars.TERM }}_associates*.csv"
sort: "newest"
type: "csv"
key: "{{ email }}"
fields:
"type": ["employee"]
# Slack normal fields
"givenName": "{{ first }}"
"familyName": "{{ last }}"
"userName": "{{ email.split('@')[0] }}"
settings:
slack_token: ""
workspace: "https://princetoncsgrad.slack.com/"
keep_customized_photos: true
keep_customized_name: true
extend_group_memberships: false
extend_channel_memberships: false
alternate_emails: "./output/alternate-emails.txt"
groups:
- name: "managers"
filter: "$.where('manager' in $.type)"
- name: "employees"
filter: "$.where('employee' in $.type)"
channels:
- name: "managers-only"
private: true
groups: ["manager"]
- name: "announcements"
permissions: "admin"
- name: "water-cooler"
groups: ["manager", "employee"]
```
## Introduction
Slack is a wonderful platform for chat, with an extensive API that allows for
many powerful integrations. But the Slack client currently (in its most frequently
available interface) does not provide any support for batch operations.
Slacktivate is a powerful tool that allows you to specify the users, group
memberships and channels in a YAML specification file, and to have the tool
automatically synchronize this specification with the Slack workspace.
Below is some context to explain why I created this tool.
### Batch managing users in channels
As an example:
- users [can only be added to a channel one-by-one](https://slack.com/help/articles/201980108-Add-people-to-a-channel),
- users can only be removed from a channel one-by-one,
and when you are managing a Slack workspace with hundreds of users, this can
become a bottleneck of operations very quickly. Slack is actively trying to
address this point, but so far, is not really making a difference---[the
channel manager that was recently introduced](https://slack.com/help/articles/360047512554-Use-channel-management-tools)
still only provides the same modal to add users, and no additional options to remove users.
This problem exists throughout Slack. Beyond the membership of channels, this
issue exists also with the membership of the workspace, of groups, and so on.
Part of the issue is that Slack Enterprise Grid product relies on a
company's existing directory solution to address these needs; but this is
of no use to the many teams that are finding success with a lower tier of
the service.
### The solution: Automating the process
## Prerequisites: Having Owner Access and Getting an API Token
In order to use the SCIM API, you need to be an owner of the workspace, and obtain an API token with `admin` scope.
As explained in [the official Slack SCIM API documentation](https://api.slack.com/scim#access), the easiest way to obtain a valid token for the purposes of SCIM provisioning is as follows:
1. As *a Workspace/Organization Owner*, create [a new app for your workspace](https://api.slack.com/apps?new_app=1) (see [here](https://api.slack.com/start/overview#creating) for the documentation).
2. Add the `admin` OAuth scope to [the "User Token Scopes" section](https://api.slack.com/authentication/quickstart#configuring).
3. Install the app to your workspace (see [here](https://api.slack.com/start/overview#installing_distributing) for the documentation).
4. Use the generated token available in the "OAuth & Permissions" tab (if you are provided with multiple tokens, use the "OAuth Access Token" not the "Bot User OAuth Access Token").
Note that you can easily *reinstall your app* with different permissions if it turns out you did not select all the necessary permissions.
## License
This project is licensed [under the LGPLv3 license](https://www.gnu.org/licenses/lgpl-3.0.en.html),
with the understanding that importing a Python modular is similar in spirit to dynamically linking
against it.
- You can use the library/CLI `slacktivate` in any project, for any purpose,
as long as you provide some acknowledgement to this original project for
use of the library (for open source software, just explicitly including
`slacktivate` in the dependency such as a `pyproject.toml` or `Pipfile`
is acknowledgement enough for me!).
- If you make improvements to `slacktivate`, you are required to make those
changes publicly available.
This license is compatible with the license of all the dependencies as
documented in [this project's own `pyproject.toml`](https://github.com/jlumbroso/slacktivate/blob/master/pyproject.toml#L29-L49).