Skip to main content

Ham Radio APRS APRSD plugin for Telegram IM service

Project description

PyPI Status Python Version License

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

pre-commit

Features

  • Have a 2 way chat with users of Telegram messenger http://telegram.org

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aprsd_telegram_plugin-0.1.3.tar.gz (12.4 kB view hashes)

Uploaded Source

Built Distribution

aprsd_telegram_plugin-0.1.3-py3-none-any.whl (6.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page