Skip to main content

Slacktivate is a Python library and Command-Line Interface to assist in the provisioning of a Slack workspace.

Project description

Slacktivate

pytest codecov Documentation Status Downloads Run on Repl.it Stargazers

Slacktivate is a Python library and Command-Line Interface to assist in the provisioning of a Slack workspace, using both the Slack API and the Slack SCIM API.

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, 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 (see here for the documentation).
  2. Add the admin OAuth scope to the "User Token Scopes" section.
  3. Install the app to your workspace (see here for the documentation).
  4. Use the generated token (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, 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.

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

slacktivate-0.2.11.tar.gz (41.8 kB view hashes)

Uploaded Source

Built Distribution

slacktivate-0.2.11-py3-none-any.whl (48.9 kB view hashes)

Uploaded Python 3

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