https://github.com/turbo87/segelflug-classifieds

Segelflug.de Kleinanzeigen Telegram Bot
https://github.com/turbo87/segelflug-classifieds

bot gliding raspberry-pi segelfliegen telegram

Last synced: 18 days ago
JSON representation

Segelflug.de Kleinanzeigen Telegram Bot

• Host: GitHub
• URL: https://github.com/turbo87/segelflug-classifieds
• Owner: Turbo87
• License: apache-2.0
• Created: 2021-01-23T14:50:41.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-17T19:43:59.000Z (21 days ago)
• Last Synced: 2024-10-20T05:54:08.829Z (18 days ago)
• Topics: bot, gliding, raspberry-pi, segelfliegen, telegram
• Language: HTML
• Homepage:
• Size: 1.18 MB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
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.

[Telegram]: https://telegram.org

[Segelflug.de Kleinanzeigen]: https://www.segelflug.de/osclass/

[Raspberry Pi]: https://www.raspberrypi.org

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 

            Maximum time to wait between server requests (in minutes) [default: 30]

        --min-time 

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

        --telegram-chat-id 

            Telegram chat ID [env: TELEGRAM_CHAT_ID] [default: @segelflug_classifieds]

        --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].

[Sentry.io]: https://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.

[systemd]: https://systemd.io

License

-------------------------------------------------------------------------------

Licensed under either of

* Apache License, Version 2.0

  ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

* MIT license

  ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

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.