python-slack-agents 0.5.0__tar.gz

python_slack_agents-0.5.0/.dockerignore

@@ -0,0 +1,11 @@
+.git
+.venv
+.env
+.env.*
+__pycache__
+*.pyc
+.pytest_cache
+.ruff_cache
+tests/
+.pre-commit-config.yaml
+.worktrees/

python_slack_agents-0.5.0/.env.example

@@ -0,0 +1,18 @@
+# Slack tokens (one set per agent, referenced via {ENV_VAR} in config.yaml)
+SLACK_BOT_TOKEN=xoxb-...
+SLACK_APP_TOKEN=xapp-...
+
+# LLM API keys
+ANTHROPIC_API_KEY=sk-ant-...
+OPENAI_API_KEY=sk-...
+
+# PostgreSQL (optional — only needed if using slack_agents.storage.postgres)
+POSTGRES_PASSWORD=your-password-here
+DATABASE_URL=postgresql://slack_agents:${POSTGRES_PASSWORD}@localhost:5432/slack_agents
+
+# Observability (optional — configured per-agent in config.yaml)
+LANGFUSE_PUBLIC_KEY=
+LANGFUSE_SECRET_KEY=
+LANGFUSE_HOST=https://cloud.langfuse.com
+
+LOG_LEVEL=DEBUG

python_slack_agents-0.5.0/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install ruff
+      - run: ruff check src/ tests/
+      - run: ruff format --check src/ tests/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: pytest
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build twine
+      - run: python -m build
+      - run: twine check dist/*

python_slack_agents-0.5.0/.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

python_slack_agents-0.5.0/.gitignore

@@ -0,0 +1,37 @@
+# Worktrees
+.worktrees/
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+*.egg-info/
+dist/
+build/
+*.egg
+.eggs/
+.venv/
+venv/
+
+# Fonts (downloaded, not committed)
+fonts/
+
+# Environment
+.env
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+agents-local/
+
+# Certificates
+*.pem
+/ONGOING.md

python_slack_agents-0.5.0/.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.7
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: local
+    hooks:
+      - id: pytest
+        name: pytest
+        entry: pytest
+        language: system
+        pass_filenames: false
+        always_run: true
+        stages: [pre-commit]
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-merge-conflict

python_slack_agents-0.5.0/AGENTS.md

@@ -0,0 +1,98 @@
+# AGENTS.md
+
+Instructions for AI coding assistants working on this codebase.
+
+## What This Is
+
+A Python framework for deploying AI agents as Slack bots. One Docker image per agent — each agent has its own Slack app identity, system prompt, LLM provider, and tool servers. No LangChain/LlamaIndex; the agent loop is a custom ~200-line async generator.
+
+## Commands
+
+```bash
+# Create and activate venv (one-time setup)
+python3 -m venv .venv
+source .venv/bin/activate
+
+# Install for development
+pip install -e ".[dev]"
+
+# Run an agent locally
+slack-agents run agents/<agent-dir>
+
+# Check agent health (requires persistent storage)
+slack-agents healthcheck agents/<agent-dir>
+
+# Export conversations to HTML
+slack-agents export-conversations agents/<agent-dir> --format=html
+
+# Build Docker image for an agent
+slack-agents build-docker agents/<agent-dir>
+
+# Build and push to a registry
+slack-agents build-docker agents/<agent-dir> --push registry.example.com
+
+# Tests (asyncio_mode=auto, no flags needed)
+pytest
+pytest tests/test_format.py           # single file
+pytest tests/test_format.py::test_name  # single test
+
+# Lint and format
+ruff check --fix src/ tests/
+ruff format src/ tests/
+```
+
+All commands assume the `.venv` virtualenv is active.
+
+Pre-commit hooks run ruff check+format automatically on commit.
+
+## Architecture
+
+**Plugin system:** All pluggable concerns (LLM, storage, tools) follow the same pattern: a `type` field with a dotted import path, and a `Provider` class in that module. `load_plugin(type_path, **kwargs)` loads any plugin.
+
+**Startup:** `main.py` -> `load_agent_config()` returns `(config, system_prompt, agent_name)` -> `SlackAgent()` -> connects storage/tools/Slack Socket Mode.
+
+**Per-message flow:** Slack event -> `agent.py._handle_message()` -> load conversation history via `ConversationManager` -> extract file attachments -> `run_agent_loop_streaming()` async generator -> `StreamingFormatter` routes text to `SlackStreamer` and tables to native `TableBlock` messages -> tool calls shown as Slack attachments -> usage footer posted -> response persisted.
+
+**Key modules:**
+- `agent_loop.py` -- Core LLM->tools->LLM loop (max 15 iterations, parallel tool execution via `asyncio.gather`), defines `ToolProvider` protocol
+- `llm/base.py` -- `BaseLLMProvider` ABC, `StreamEvent` dataclass, internal Anthropic-style message format
+- `llm/anthropic.py`, `llm/openai.py` -- Provider implementations (OpenAI provider converts at its boundary)
+- `tools/base.py` -- `BaseToolProvider` and `BaseFileImporterProvider` ABCs with `allowed_functions` regex filtering
+- `tools/mcp_http.py` -- MCP over HTTP/SSE tool provider
+- `tools/file_exporter.py` -- Built-in document generation tool (PDF, DOCX, XLSX, CSV, PPTX)
+- `tools/file_importer.py` -- Built-in file import provider (PDF, DOCX, XLSX, PPTX, text, images)
+- `storage/base.py` -- `BaseStorageProvider` ABC (generic persistence layer)
+- `storage/sqlite.py` -- SQLite storage provider (in-memory or file-based, via aiosqlite)
+- `storage/postgres.py` -- PostgreSQL storage provider (asyncpg)
+- `slack/agent.py` -- `SlackAgent` with Bolt AsyncApp, event routing, cost tracking
+- `slack/conversations.py` -- `ConversationManager` wrapping storage with conversation logic
+- `slack/streaming.py` + `streaming_formatter.py` -- Streaming output with table detection
+
+**Internal message format is Anthropic-style throughout** (content as list of typed blocks: `text`, `tool_use`, `tool_result`). The OpenAI provider converts at its boundary via `_convert_messages()` and `_convert_tools()`.
+
+## Agent Configuration
+
+Each agent lives in `agents/<name>/` with `config.yaml` and `system_prompt.txt`. The agent name is derived from the directory name. Config supports `{ENV_VAR}` interpolation (uppercase + underscore patterns only).
+
+**Top-level config fields:**
+- `version` (required) -- user-controlled string shown in the usage footer **and used as the Docker image tag** when building with `slack-agents build-docker`. Track changes to the agent's prompts, tools, or behavior. The framework does not interpret this — it can be semver, a date, or any string.
+- `schema` (required) -- config format identifier, currently `"slack-agents/v1"`. The framework checks this to ensure it can parse the config. Newer schemas fail with a clear upgrade message.
+
+## Key Design Decisions
+
+- **Async everywhere** -- all I/O (Slack, LLM, tools, storage) is async
+- **Streaming as async generator** -- `run_agent_loop_streaming()` yields `StreamEvent` (text) and `dict` (tool status)
+- **Unified tool interface** -- `BaseToolProvider` ABC (`.tools` + `.call_tool()`) for LLM-facing tools; `BaseFileImporterProvider` ABC (`.handlers`) for file import — both configured in `tools:` section, separated by isinstance in `_init_tools()`
+- **Explicit configuration over silent defaults** -- do not auto-load providers when none are configured; if no `BaseFileImporterProvider` is in the config, file attachments are rejected with a clear error
+- **Generic storage** -- `BaseStorageProvider` knows nothing about conversations; `ConversationManager` adds conversation logic on top
+- **Lazy initialization** -- SlackStreamer creates stream on first delta; tools connect only when initialized
+- **Caching-aware cost tracking** -- each LLM provider has `estimate_cost()` with provider-specific cache multipliers
+- **Tool definitions in Anthropic format** -- `{"name", "description", "input_schema"}` is the canonical format everywhere
+- **1 replica per agent** -- Socket Mode requires exactly one WebSocket connection per app
+
+## Style
+
+- Python 3.12+, line length 100
+- Ruff rules: E, F, I (errors, pyflakes, isort)
+- Keep it simple. Minimal abstractions, no unnecessary indirection.
+- Commit messages: Conventional Commits — `feat:`, `fix:`, `docs:`, `chore:`, `test:`, `refactor:`. Lowercase, imperative, under 72 chars.

python_slack_agents-0.5.0/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/), and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [0.5.0] - 2025-03-13
+
+### Added
+
+- Plugin architecture for LLM providers, storage backends, and tools
+- Anthropic and OpenAI LLM providers
+- SQLite and PostgreSQL storage providers
+- MCP over HTTP tool provider
+- Built-in document export tools (PDF, DOCX, XLSX, CSV, PPTX)
+- Streaming output with native Slack table rendering
+- Socket Mode support (no public URL required)
+- OpenTelemetry observability
+- `{ENV_VAR}` interpolation in agent configs
+- Per-agent Docker builds via `docker-build-and-push.sh`

python_slack_agents-0.5.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,9 @@
+# Code of Conduct
+
+This project follows the [Contributor Covenant v2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
+
+In short: be respectful, be constructive, be inclusive. Harassment and exclusionary behavior are not tolerated.
+
+## Reporting
+
+Report unacceptable behavior to the project maintainers via GitHub. All reports will be reviewed and handled confidentially.

python_slack_agents-0.5.0/CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# Contributing
+
+Contributions are welcome — bug fixes, features, docs, examples.
+
+## Before You Start
+
+- **Bug fixes and small improvements** — go ahead and open a PR.
+- **Large features or architectural changes** — open an issue first to discuss the approach.
+
+## Setup
+
+Requires Python >= 3.12.
+
+```bash
+git clone https://github.com/CompareNetworks/python-slack-agents.git
+cd python-slack-agents
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+pre-commit install
+```
+
+## Development
+
+```bash
+# Run tests
+pytest
+
+# Lint and format (also runs automatically on commit via pre-commit hooks)
+ruff check --fix src/ tests/
+ruff format src/ tests/
+```
+
+## Commit Messages
+
+We use [Conventional Commits](https://www.conventionalcommits.org/) — lowercase, imperative, short:
+
+```
+feat: add canvas tool provider
+fix: streaming drops last chunk on disconnect
+docs: clarify MCP server configuration
+chore: bump dependencies
+test: cover PostgreSQL export edge cases
+refactor: simplify streaming formatter table detection
+```
+
+Prefixes: `feat:`, `fix:`, `docs:`, `chore:`, `test:`, `refactor:`. First line under 72 characters. Add a body after a blank line if context is needed.
+
+## Pull Requests
+
+1. Fork the repo and create a branch
+2. Make your changes
+3. Ensure tests pass and linting is clean
+4. Open a PR with a clear description of what and why
+
+Keep PRs focused — one concern per PR. Small PRs get reviewed faster.
+
+## Style
+
+- Python 3.12+, line length 100
+- Ruff rules: E, F, I
+- Keep it simple — minimal abstractions, no over-engineering
+- Type hints on function signatures
+- Tests for new functionality
+
+## Adding a Plugin
+
+LLM providers, storage backends, and tools all follow the same pattern: a module with a `Provider` class. See the [docs/](docs/) directory for guides on creating each type.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.

python_slack_agents-0.5.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.