Package `telereddit`

Telereddit

Add this bot on Telegram: telegram.me!

Telereddit is a Telegram bot which lets you easily see shared Reddit posts previews directly in the group chat. This bot will also automatically send a random post from a subreddit when you name it.

Like the project?

Features

Post sharing

Random post from a subreddit

Get it on telegram.me!

Installation

Clone the repository
Install requirements bash pip install -r requirements.txt
Set up Telegram token and API keys by duplicating and filling out ./telereddit/config/template.env
Set the environment variable REDDIT_BOTS_MACHINE to the name of the env file (e.g.: for dev.env set REDDIT_BOTS_MACHINE=DEV)
Start the bot bash python -m telereddit
Enjoy

Bugs and feature requests

If you want to report a bug or would like a feature to be added, feel free to open an issue.

Versioning

We follow Semantic Versioning. The version X.Y.Z indicates:

X is the major version (backward-incompatible),
Y is the minor version (backward-compatible), and
Z is the patch version (backward-compatible bug fix).

License

Sub-modules

telereddit.config: Project-wide configuration module …
telereddit.exceptions: Catched exceptions of the software …
telereddit.linker: Linker class which handles all telereddit requests.
telereddit.telereddit: Entrypoint module …
telereddit.tests