Skip to content

Aqendo/xkcd-inline-bot

Repository files navigation

XKCD Inline Bot

Bot in use

An inline Telegram bot for accessing XKCD.COM comics in a convenient manner

Live instance

This bot can be found at @xkcd_com_bot

Installation

Local installation

$ git clone https://github.com/Aqendo/xkcd-inline-bot --depth=1 # Shallow clone of the repo
$ cd xkcd-inline-bot
$ uv sync # Install all dependencies
$ cp .env{.example,}
$ vi .env # Change environment variables
$ uv run bot.py

Docker installation

$ git clone https://github.com/Aqendo/xkcd-inline-bot --depth=1 # Shallow clone of the repo
$ cd xkcd-inline-bot
$ cp .env{.example,}
$ vi .env # Change environment variables
$ cp docker-compose{.example,}.yml
$ vi docker-compose.yml # Make sure path to comics info json file is in sync with .env file
$ docker compose up --build

LICENSE

XKCD Inline bot - An inline Telegram bot for accessing XKCD.COM comics in a convenient manner
Copyright (C) 2025 Sergey Sitnikov
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>

About

An inline Telegram bot for accessing XKCD.COM comics in a convenient manner

Topics

Resources

License

Stars

Watchers

Forks