Composable backend selection, Telegram support, and Diataxis docs#76
Merged
Conversation
Make it trivial to run a bot against any combination of backends and add Telegram as a first-class backend. Backends: - Add a top-level `backend` Hydra group (slack/discord/symphony/telegram), each fragment writing to a distinct BotConfig field so any combination can be selected at once, e.g. `+gateway=bot +backend=[slack,telegram]`. - Add a bare `gateway/bot.yaml` skeleton; rewrite the pre-canned gateways (slack, discord, symphony, telegram, mixed, all) as thin selectors that match the chatom-based BotConfig and read credentials from env vars. - Update example configs and add an ad-hoc `custom.yaml`. Telegram: - Add csp_bot/backends/telegram.py, TelegramConfig and the telegram field on BotConfig, adapter init and user-access wiring in Bot, HTML help formatting, the Backend literal entry, exports, and the dev dependency. Docs (Diataxis restructure): - Slim Overview to orientation + getting started; rewrite Configuration around the two config groups; add Backends and Commands reference pages and a Writing-Commands how-to; update Installation, README, and sidebar. Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
Contributor
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #76 +/- ##
==========================================
+ Coverage 65.34% 65.49% +0.14%
==========================================
Files 29 29
Lines 1665 1672 +7
Branches 170 170
==========================================
+ Hits 1088 1095 +7
Misses 545 545
Partials 32 32 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Make it trivial to run a bot against any combination of backends and add Telegram as a first-class backend.
Backends:
backendHydra group (slack/discord/symphony/telegram), each fragment writing to a distinct BotConfig field so any combination can be selected at once, e.g.+gateway=bot +backend=[slack,telegram].gateway/bot.yamlskeleton; rewrite the pre-canned gateways (slack, discord, symphony, telegram, mixed, all) as thin selectors that match the chatom-based BotConfig and read credentials from env vars.custom.yaml. Telegram: