Skip to main content

Opinionated, testable Python wrappers for Slack’s Web, Admin, and SCIM APIs, organized by object domain (users, conversations, messages, files, workspaces, and IdP groups). Designed for automation and administration workflows.

Project description

slack-objects

A focused Python package for working with Slack objects commonly used in administration and automation workflows.

slack-objects provides opinionated, testable wrappers around the Slack Web API, Admin API, and SCIM API—favoring object-based access over raw endpoint calls.


Supported Slack Objects

The following Slack object types are supported:

  • Users
  • Conversations (e.g, channels)
  • Messages
  • Files
  • Workspaces
  • IDP Groups (SCIM - e.g., Okta groups)

Overview

slack-objects is designed for:

  • Slack administration automation
  • Identity and access management (IAM) workflows
  • Internal tooling and bots
  • Auditing and cleanup scripts

This package is not a replacement for slack_sdk. Instead, it focuses on higher-level object operations that typically require:

  • multiple API calls
  • pagination
  • rate limiting
  • Admin API or SCIM usage
  • non-trivial orchestration logic

Design Highlights

Factory-based API

All object helpers are created from a single entry point:

from slack_objects import SlackObjectsClient, SlackObjectsConfig

cfg = SlackObjectsConfig(bot_token="xoxb-...", user_token="xoxp-...", scim_token="xoxp-...", ...)
slack = SlackObjectsClient(cfg)

users = slack.users()
alice = slack.users("U123")

conversations = slack.conversations()
general = slack.conversations("C123")

This avoids global state while keeping usage concise and consistent.


Explicit token model

Slack APIs have different authorization requirements. This package keeps tokens explicit and separate:

Token Used for
bot_token Slack Web API (most read/write operations)
user_token Slack Admin API
scim_token Slack SCIM API (IdP / provisioning)

Tokens are optional in configuration, but required by methods that need them. Errors are raised at call time with clear messages.


Strict method boundaries

Each object follows a consistent internal structure:

public method
    → wrapper method
        → SlackApiCaller / SCIM request

Keyword-only APIs

Methods with multiple optional parameters use keyword-only arguments to avoid ambiguity and future breaking changes.


Testability

The codebase is designed to be tested without hitting Slack.


Installation

pip install slack-objects

Configuration

from slack_objects.config import SlackObjectsConfig, RateTier

cfg = SlackObjectsConfig(
    bot_token="xoxb-...",
    user_token="xoxp-...",
    scim_token="xoxp-...",
    default_rate_tier=RateTier.TIER_3,
)

Testing

Run all smoke tests:

python -m tests.run_all_smoke

Notes

  • SCIM v2 is the default; v1 is supported where applicable
  • PC_Utils is a required dependency (used for datetime handling, e.g., guest expiration dates)
  • This package is intended for automation and administration workflows

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

slack_objects-0.0.3.tar.gz (45.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

slack_objects-0.0.3-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

Details for the file slack_objects-0.0.3.tar.gz.

File metadata

  • Download URL: slack_objects-0.0.3.tar.gz
  • Upload date:
  • Size: 45.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for slack_objects-0.0.3.tar.gz
Algorithm Hash digest
SHA256 709b1c9b7a15fcf47b252f7cb90bb7ab5785e01fedce0e9df4c355865a841108
MD5 951aebe71a176d087dafc6cb1e67a5b3
BLAKE2b-256 0438e50e3d9e97ac1b294dce586feef3f556e9764d7ba05ed25715ae9520ca9e

See more details on using hashes here.

Provenance

The following attestation bundles were made for slack_objects-0.0.3.tar.gz:

Publisher: publish-pypi.yml on mmercad0/slack-objects

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file slack_objects-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: slack_objects-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 31.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for slack_objects-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2be011255105602db04ebcbea014d7b871062ebd84dba32a798dcdc701f6788c
MD5 6fa8a7be17ae043372cb8db9b0c12d24
BLAKE2b-256 a797e41c00b5bd34eca42dcadce16b63d8b08017ff9353ac8cd3bf5858831d05

See more details on using hashes here.

Provenance

The following attestation bundles were made for slack_objects-0.0.3-py3-none-any.whl:

Publisher: publish-pypi.yml on mmercad0/slack-objects

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page