/tg-feed

Daemon to send Telegram notifies about new articles

Primary LanguagePython

Telegram Feed

Daemon to watch for multiple web resources, parse for some data and send notifies to Telegram on updates.

Useful to watch for low-frequent updates:

  • Blog posts, when there's no RSS/Atom
  • Open positions at custom careers page
  • Academic articles :)

Not recommended for other cases since it uses really dumb and straightforward approach.

Usage

  • Edit config.example.yml with:

    • Proper token
    • Channel/group ID
    • Resources specs

    Save resulting file it as config.yml

  • Run container with your config and persistent data folder:

    docker run \
  --rm -d --name tg-feed \
  -v ./config.yml:/app/config.yml \
  agrrh/tg-feed

Class Diagram

This code requires Mermaid JS to be displayed. At the moment, GitHub doesn't support it, so feel free to:

classDiagram

class ResourceManager {
  Storage storage
  Resource resource
  Piece checkpoint

  check_resource()
  select_news()
  notify()
}

class Resource {
  string uuid
  string url
  Target target

  get()
  parse()
}

class Target {
  string url_selector
  string text_selector

  find()
}

class Piece {
  string url
  string text
  string hash
  string pretty
}

class Storage {
  string path

  put()
  get()
}

class TelegramBot {
  string target_id

  send()
}

Resource *-- Target
Target *-- Piece

Credits