Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nekomeowww/tgo
Telegram Bot framework & utilities for Go, built on top of telegram-bot-api, can be used as drop-in-replacement. With @nekomeowww's flavor, born from varies of Telegram Bot projects.
https://github.com/nekomeowww/tgo
bots grammyjs telegrafjs telegram-bot telegram-bot-api
Last synced: 10 days ago
JSON representation
Telegram Bot framework & utilities for Go, built on top of telegram-bot-api, can be used as drop-in-replacement. With @nekomeowww's flavor, born from varies of Telegram Bot projects.
- Host: GitHub
- URL: https://github.com/nekomeowww/tgo
- Owner: nekomeowww
- License: mit
- Created: 2024-11-04T17:17:59.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-27T06:44:51.000Z (about 2 months ago)
- Last Synced: 2024-12-19T08:42:05.908Z (24 days ago)
- Topics: bots, grammyjs, telegrafjs, telegram-bot, telegram-bot-api
- Language: Go
- Homepage:
- Size: 73.2 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `tgo`
[](https://pkg.go.dev/github.com/nekomeowww/tgo)
[](https://goreportcard.com/report/github.com/nekomeowww/tgo)
Telegram Bot framework & utilities for Go, built on top of telegram-bot-api, can be used as drop-in-replacement. With [@nekomeowww](https://github.com/nekomeowww)'s flavor, born from varies of Telegram Bot projects.
- [`insights-bot`](https://github.com/nekomeowww/insights-bot)
- [`perobot`](https://github.com/nekomeowww/perobot)
- [`factorio-chat-bridge`](https://github.com/nekomeowww/factorio-chat-bridge)
## Features
- [x] 🎺 Wrapper for commands, callback queries, inline queries
- [x] 🎆 Any-length callback query data, no more 64-bytes fighting
- [x] 🎯 Battle-tested dispatcher for each supported updates
- [x] 👮 Middleware support (guard, permission check, etc.)
- [x] 🌍 Opt-in i18n support
- [x] 🚀 Easy to use, easy to extend
- [x] 🍱 Useful helpers for permission check, message handling, error handling
- [x] 📦 Dependency injection friendly
- [x] 📚 More examples and documentation
- [x] 🛜 Out of the box support for webhooks & polling
## 🤠 Spec & Documentation
GoDoc: [https://godoc.org/github.com/nekomeowww/tgo](https://godoc.org/github.com/nekomeowww/tgo)
## Usage
```shell
go get -u github.com/nekomeowww/tgo
```
```go
package main
import (
"context"
"os"
"github.com/nekomeowww/tgo"
)
func main() {
bot, err := tgo.NewBot(
tgo.WithToken(os.Getenv("TELEGRAM_BOT_TOKEN")),
)
if err != nil {
panic(err)
}
bot.OnCommand("ping", nil, tgo.NewHandler(func(ctx *tgo.Context) (tgo.Response, error) {
return ctx.NewMessage("pong"), nil
}))
bot.Bootstrap(context.TODO())
}
```
if you use `uber/fx` too, you can follow this example:
```go
package main
import (
"context"
"fmt"
"log"
"os"
"time"
"github.com/nekomeowww/fo"
"github.com/nekomeowww/tgo"
"go.uber.org/fx"
)
func NewBot() func() (*tgo.Bot, error) {
return func() (*tgo.Bot, error) {
bot, err := tgo.NewBot(tgo.WithToken(os.Getenv("TELEGRAM_BOT_TOKEN")))
if err != nil {
return nil, err
}
bot.OnCommand("ping", nil, tgo.NewHandler(func(ctx *tgo.Context) (tgo.Response, error) {
return ctx.NewMessage("pong"), nil
}))
return bot, nil
}
}
func Run() func(fx.Lifecycle, *tgo.Bot) {
return func(lifecycle fx.Lifecycle, bot *tgo.Bot) {
lifecycle.Append(fx.Hook{
OnStart: func(ctx context.Context) error {
go func() {
_ = bot.Start(ctx)
}()
return nil
},
OnStop: func(ctx context.Context) error {
return bot.Stop(ctx)
},
})
}
}
func main() {
app := fx.New(
fx.Provide(NewBot()),
fx.Invoke(Run()),
)
app.Run()
stopCtx, stopCtxCancel := context.WithTimeout(context.Background(), time.Second*15)
defer stopCtxCancel()
if err := app.Stop(stopCtx); err != nil {
log.Fatal(err)
}
}
```
## 👪 Other family members of `anyo`
- [nekomeowww/xo](https://github.com/nekomeowww/xo): Mega utility & helper & extension library for Go
- [nekomeowww/fo](https://github.com/nekomeowww/fo): Functional programming utility library for Go
- [nekomeowww/bo](https://github.com/nekomeowww/bo): BootKit for easily bootstrapping multi-goroutine applications, CLIs
- [nekomeowww/wso](https://github.com/nekomeowww/wso): WebSocket utility library for Go
## 🎆 Other cool related Golang projects I made & maintained
- [nekomeowww/factorio-rcon-api](https://github.com/nekomeowww/factorio-rcon-api): Fully implemented wrapper for Factorio RCON as API
- [Kollama - Ollama Operator](https://github.com/knoway-dev/knoway): Kubernetes Operator for managing Ollama instances across multiple clusters
- [lingticio/llmg](https://github.com/lingticio/llmg): LLM Gateway with gRPC, WebSocket, and RESTful API adapters included.
- [nekomeowww/hyphen](https://github.com/nekomeowww/hyphen): An elegant URL Shortener service
- [nekomeowww/insights-bot](https://github.com/nekomeowww/insights-bot): Webpage summary & chat history recap bot for Telegram