/aprsd-telegram-plugin

APRSD APRS Telegram Messenger plugin

Primary LanguagePythonMIT LicenseMIT

aprsd-telegram-plugin

PyPI Status Python Version License

Read the documentation at https://aprsd-telegram-plugin.readthedocs.io/ Tests Codecov

pre-commit

Features

Requirements

  • You have to create a telegram bot and start the bot
  • Telegram users have to add that bot and then /start
  • Telegram user can then message the bot
  • Only after a telegram user has successfully completed the above can you then message a telegram user from an APRS enabled HAM Radio.

Installation

You can install aprsd-telegram-plugin via pip from PyPI:

$ pip install aprsd-telegram-plugin

Now edit your aprsd.yml config file and add the plugin

aprsd:
  enabled_plugins:
    - aprsd_telegram_plugin.telegram.TelegramChatPlugin

services:
  telegram:
    apiKey: <Your Telegram bot APIkey>
    shortcuts:
      'wb': hemna6969

Usage

Please see the Command-line Reference for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, aprsd-telegram-plugin is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @hemna's APRSD Plugin Python Cookiecutter template.