๐Ÿ“ฆ Stream29 / TelegramTrigger

๐Ÿ“„ CLAUDE.md ยท 54 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Project Overview

This is a **Telegram Trigger Plugin** project for Dify. 
The project is in early setup phase with reference documentation gathered. 
The goal is to build a plugin that receives Telegram bot updates (messages, commands, callbacks) and triggers Dify workflows using the Dify Plugin SDK (Python).

Any progress should be updated in this file.

## Current Project Structure

```
TelegramTrigger/
โ”œโ”€โ”€ references/                          # Reference documentation
โ”‚   โ”œโ”€โ”€ trigger-plugin-development-guide.md  # Complete guide to Trigger plugin development
โ”‚   โ”œโ”€โ”€ TelegramBotsApi.md                   # Telegram Bot API documentation (523KB)
โ”‚   โ””โ”€โ”€ dify-plugin-sdks/                    # Dify Plugin SDK (git submodule)
โ”œโ”€โ”€ pyproject.toml                       # Python project configuration
โ””โ”€โ”€ .venv/                               # Python virtual environment
```

You should read `TelegramBotsApi.md` to get knowledge about telegram bots and telegram bot API.

You can read `dify-plugin-sdks` to get knowledge about Dify Plugin SDK and plugin examples.
`references/trigger-plugin-development-guide.md` is a simple guide write from it.

## Development Requirements

### Type Checking

```powershell
uvx ty check --exclude references
```

`ty` should be used to check type safety every time a change is made.

### Dependency Management

```powershell
uv add <dependency>
```

```powershell
uv sync
```

```powershell
uv run <script>
```

`uv` should be used to manage dependencies and run scripts. `python` or `pip` should not be used.