| Name | aprsd-telegram-plugin JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | |
| Summary | Ham Radio APRS APRSD plugin for Telegram IM service |
| upload_time | 2022-12-02 19:07:19 |
| maintainer | |
| docs_url | None |
| author | Walter A. Boring IV |
| requires_python | |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
aprsd-telegram-plugin
=====================
|PyPI| |Status| |Python Version| |License|
|Read the Docs| |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_:
.. code:: console
$ pip install aprsd-telegram-plugin
Now edit your aprsd.yml config file and add the plugin
.. code:: yaml
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 <Usage_>`_ 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.
.. _@hemna: https://github.com/hemna
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _MIT license: https://opensource.org/licenses/MIT
.. _PyPI: https://pypi.org/
.. _APRSD Plugin Python Cookiecutter: https://github.com/hemna/cookiecutter-aprsd-plugin
.. _file an issue: https://github.com/hemna/aprsd-telegram-plugin/issues
.. _pip: https://pip.pypa.io/
.. github-only
.. _Contributor Guide: CONTRIBUTING.rst
.. _Usage: https://aprsd-telegram-plugin.readthedocs.io/en/latest/usage.html
.. badges
.. |PyPI| image:: https://img.shields.io/pypi/v/aprsd-telegram-plugin.svg
:target: https://pypi.org/project/aprsd-telegram-plugin/
:alt: PyPI
.. |Status| image:: https://img.shields.io/pypi/status/aprsd-telegram-plugin.svg
:target: https://pypi.org/project/aprsd-telegram-plugin/
:alt: Status
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/aprsd-telegram-plugin
:target: https://pypi.org/project/aprsd-telegram-plugin
:alt: Python Version
.. |License| image:: https://img.shields.io/pypi/l/aprsd-telegram-plugin
:target: https://opensource.org/licenses/MIT
:alt: License
.. |Read the Docs| image:: https://img.shields.io/readthedocs/aprsd-telegram-plugin/latest.svg?label=Read%20the%20Docs
:target: https://aprsd-telegram-plugin.readthedocs.io/
:alt: Read the documentation at https://aprsd-telegram-plugin.readthedocs.io/
.. |Tests| image:: https://github.com/hemna/aprsd-telegram-plugin/workflows/Tests/badge.svg
:target: https://github.com/hemna/aprsd-telegram-plugin/actions?workflow=Tests
:alt: Tests
.. |Codecov| image:: https://codecov.io/gh/hemna/aprsd-telegram-plugin/branch/main/graph/badge.svg
:target: https://codecov.io/gh/hemna/aprsd-telegram-plugin
:alt: Codecov
.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
:target: https://github.com/pre-commit/pre-commit
:alt: pre-commit
Raw data
{
"_id": null,
"home_page": "",
"name": "aprsd-telegram-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Walter A. Boring IV",
"author_email": "waboring@hemna.com",
"download_url": "https://files.pythonhosted.org/packages/54/f8/02d7677a2a0d6b9d8ecf9f0e08c5547f3d5689e89151ec53274fdde3b307/aprsd_telegram_plugin-0.1.3.tar.gz",
"platform": null,
"description": "aprsd-telegram-plugin\n=====================\n\n|PyPI| |Status| |Python Version| |License|\n\n|Read the Docs| |Tests| |Codecov|\n\n|pre-commit|\n\n\nFeatures\n--------\n\n* Have a 2 way chat with users of Telegram messenger `http://telegram.org`\n\nRequirements\n------------\n\n* You have to create a telegram bot and start the bot\n* Telegram users have to add that bot and then /start\n* Telegram user can then message the bot\n* Only after a telegram user has successfully completed the above\n can you then message a telegram user from an APRS enabled HAM Radio.\n\nInstallation\n------------\n\nYou can install *aprsd-telegram-plugin* via pip_ from PyPI_:\n\n.. code:: console\n\n $ pip install aprsd-telegram-plugin\n\n\nNow edit your aprsd.yml config file and add the plugin\n\n.. code:: yaml\n\n aprsd:\n enabled_plugins:\n - aprsd_telegram_plugin.telegram.TelegramChatPlugin\n\n services:\n telegram:\n apiKey: <Your Telegram bot APIkey>\n shortcuts:\n 'wb': hemna6969\n\n\n\nUsage\n-----\n\nPlease see the `Command-line Reference <Usage_>`_ for details.\n\n\nContributing\n------------\n\nContributions are very welcome.\nTo learn more, see the `Contributor Guide`_.\n\n\nLicense\n-------\n\nDistributed under the terms of the `MIT license`_,\n*aprsd-telegram-plugin* is free and open source software.\n\n\nIssues\n------\n\nIf you encounter any problems,\nplease `file an issue`_ along with a detailed description.\n\n\nCredits\n-------\n\nThis project was generated from `@hemna`_'s `APRSD Plugin Python Cookiecutter`_ template.\n\n.. _@hemna: https://github.com/hemna\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _MIT license: https://opensource.org/licenses/MIT\n.. _PyPI: https://pypi.org/\n.. _APRSD Plugin Python Cookiecutter: https://github.com/hemna/cookiecutter-aprsd-plugin\n.. _file an issue: https://github.com/hemna/aprsd-telegram-plugin/issues\n.. _pip: https://pip.pypa.io/\n.. github-only\n.. _Contributor Guide: CONTRIBUTING.rst\n.. _Usage: https://aprsd-telegram-plugin.readthedocs.io/en/latest/usage.html\n\n\n.. badges\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/aprsd-telegram-plugin.svg\n :target: https://pypi.org/project/aprsd-telegram-plugin/\n :alt: PyPI\n.. |Status| image:: https://img.shields.io/pypi/status/aprsd-telegram-plugin.svg\n :target: https://pypi.org/project/aprsd-telegram-plugin/\n :alt: Status\n.. |Python Version| image:: https://img.shields.io/pypi/pyversions/aprsd-telegram-plugin\n :target: https://pypi.org/project/aprsd-telegram-plugin\n :alt: Python Version\n.. |License| image:: https://img.shields.io/pypi/l/aprsd-telegram-plugin\n :target: https://opensource.org/licenses/MIT\n :alt: License\n.. |Read the Docs| image:: https://img.shields.io/readthedocs/aprsd-telegram-plugin/latest.svg?label=Read%20the%20Docs\n :target: https://aprsd-telegram-plugin.readthedocs.io/\n :alt: Read the documentation at https://aprsd-telegram-plugin.readthedocs.io/\n.. |Tests| image:: https://github.com/hemna/aprsd-telegram-plugin/workflows/Tests/badge.svg\n :target: https://github.com/hemna/aprsd-telegram-plugin/actions?workflow=Tests\n :alt: Tests\n.. |Codecov| image:: https://codecov.io/gh/hemna/aprsd-telegram-plugin/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/hemna/aprsd-telegram-plugin\n :alt: Codecov\n.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\n :target: https://github.com/pre-commit/pre-commit\n :alt: pre-commit\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Ham Radio APRS APRSD plugin for Telegram IM service",
"version": "0.1.3",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "f48637c001f05fc31de94f2e5c3df6dd",
"sha256": "94acee71da65eab8d97a9ecb4121894234b77edf63bad8af6ba408b9902a2996"
},
"downloads": -1,
"filename": "aprsd_telegram_plugin-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f48637c001f05fc31de94f2e5c3df6dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6306,
"upload_time": "2022-12-02T19:07:15",
"upload_time_iso_8601": "2022-12-02T19:07:15.263131Z",
"url": "https://files.pythonhosted.org/packages/6c/16/2acaca474f960279301393b17902dd022d2203f326f6466902ea3b293f1a/aprsd_telegram_plugin-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "68bf389bfe373366bcfa2fc101f63812",
"sha256": "dd95bc4fb39ba68b88dc199c14bd8b58c5710a04c85b18fdacf2c8524132769d"
},
"downloads": -1,
"filename": "aprsd_telegram_plugin-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "68bf389bfe373366bcfa2fc101f63812",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 12410,
"upload_time": "2022-12-02T19:07:19",
"upload_time_iso_8601": "2022-12-02T19:07:19.596337Z",
"url": "https://files.pythonhosted.org/packages/54/f8/02d7677a2a0d6b9d8ecf9f0e08c5547f3d5689e89151ec53274fdde3b307/aprsd_telegram_plugin-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-02 19:07:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "aprsd-telegram-plugin"
}
