Skip to content

Segelflug.de Kleinanzeigen Telegram Bot

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

Turbo87/segelflug-classifieds

Repository files navigation

segelflug-classifieds

Segelflug.de Kleinanzeigen Telegram Bot

This project implements a basic Telegram bot that regularly polls the Segelflug.de Kleinanzeigen page for new items and sends them to a public Telegram channel. The bot is intended to run on a Raspberry Pi, so ARM cross-compilation compatibility is a requirement for any changes.

Usage

$ segelflug-classifieds --help 

USAGE:
    segelflug-classifieds [FLAGS] [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
    -w, --watch      Run continuously and poll the server in random intervals

OPTIONS:
        --max-time <max-time>
            Maximum time to wait between server requests (in minutes) [default: 30]

        --min-time <min-time>
            Minimum time to wait between server requests (in minutes) [default: 10]

        --telegram-chat-id <telegram-chat-id>
            Telegram chat ID [env: TELEGRAM_CHAT_ID] [default: @segelflug_classifieds]

        --telegram-token <telegram-token>        
            Telegram bot token [env: TELEGRAM_TOKEN]

If no Telegram token is provided the application will only output the new items on the console, if a token is provided they will also be sent to the configurable Telegram channel.

In addition to these options a SENTRY_DSN environment variable can also be set to enable error reporting on Sentry.io.

Deployment

As mentioned above, the intended deployment target is a Raspberry Pi. A deploy.sh shell script is included in this repository to simplify the deployment process. This script needs to be configured by setting the TARGET_HOST and TARGET_PATH environment variables.

An example systemd service file is also provided in the systemd folder of this repository.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.