Skip to content

Latest commit

 

History

History
77 lines (58 loc) · 3.59 KB

README.md

File metadata and controls

77 lines (58 loc) · 3.59 KB
Raw

telereddit

Telereddit

Docs status Test status Lint status Coverage Status Codacy Badge Maintainability Docs coverage Code style: black

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?

Buy Me A Coffee

Features

Post sharing

Post sharing

Random post from a subreddit

Random post from a subreddit

Get it on telegram.me!

Installation

  1. Clone the repository
  2. Install requirements 
    pip install -r requirements.txt
  3. Set up Telegram token and API keys by duplicating and filling out ./telereddit/config/template.env
  4. Set the environment variable REDDIT_BOTS_MACHINE to the name of the env file (e.g.: for dev.env set REDDIT_BOTS_MACHINE=DEV)
  5. Start the bot 
    python -m telereddit
  6. 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

GPL v3 - Copyright 2020 © fabio.sangregorio.dev.