mirror of
https://github.com/hemna/aprsd-telegram-plugin.git
synced 2024-12-22 09:31:47 -05:00
Updated config options
This also updates the README
This commit is contained in:
parent
9f87a8fec9
commit
a4dfb1393d
33
README.rst
33
README.rst
@ -32,20 +32,33 @@ You can install *aprsd-telegram-plugin* via pip_ from PyPI_:
|
|||||||
$ pip install aprsd-telegram-plugin
|
$ pip install aprsd-telegram-plugin
|
||||||
|
|
||||||
|
|
||||||
Now edit your aprsd.yml config file and add the plugin
|
Now edit your aprsd.conf config file and add the plugin
|
||||||
|
|
||||||
.. code:: yaml
|
.. code:: ini
|
||||||
|
|
||||||
aprsd:
|
|
||||||
enabled_plugins:
|
|
||||||
- aprsd_telegram_plugin.telegram.TelegramChatPlugin
|
|
||||||
|
|
||||||
services:
|
[DEFAULT]
|
||||||
telegram:
|
enabled_plugins = aprsd_telegram_plugin.telegram.TelegramChatPlugin
|
||||||
apiKey: <Your Telegram bot APIkey>
|
|
||||||
shortcuts:
|
|
||||||
'wb': hemna6969
|
|
||||||
|
|
||||||
|
[aprsd_telegram_plugin]
|
||||||
|
|
||||||
|
#
|
||||||
|
# From aprsd_telegram_plugin.conf
|
||||||
|
#
|
||||||
|
|
||||||
|
# Callsign allowed to use Telegram! For example, if you set this to
|
||||||
|
# WB4BOR then anycallsign starting with WB4BOR will be allowed to use
|
||||||
|
# this.This way WB4BOR-1 can use this instance. (string value)
|
||||||
|
#callsign = <None>
|
||||||
|
|
||||||
|
# Your telegram apiKeyInformation for creating your api keys is here:
|
||||||
|
# https://core.telegram.org/api/obtaining_api_id (string value)
|
||||||
|
#apiKey = <None>
|
||||||
|
|
||||||
|
# List of shortcuts for sending telegram messages For Example:
|
||||||
|
# wb=hemna6969,cl=craigerl
|
||||||
|
# Means use 'wb' to send a telegram message to hemna6969 (list value)
|
||||||
|
#shortcuts = <None>
|
||||||
|
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
|
@ -1,9 +1,6 @@
|
|||||||
import logging
|
from aprsd_telegram_plugin.conf import telegram
|
||||||
|
|
||||||
from aprsd_twitter_plugin.conf import twitter
|
|
||||||
from oslo_config import cfg
|
from oslo_config import cfg
|
||||||
|
|
||||||
|
|
||||||
CONF = cfg.CONF
|
CONF = cfg.CONF
|
||||||
|
telegram.register_opts(CONF)
|
||||||
twitter.register_opts(CONF)
|
|
||||||
|
@ -12,18 +12,18 @@ telegram_opts = [
|
|||||||
help="Callsign allowed to use Telegram! "
|
help="Callsign allowed to use Telegram! "
|
||||||
"For example, if you set this to WB4BOR then any"
|
"For example, if you set this to WB4BOR then any"
|
||||||
"callsign starting with WB4BOR will be allowed to use this."
|
"callsign starting with WB4BOR will be allowed to use this."
|
||||||
"This way WB4BOR-1 can tweet from this instance.",
|
"This way WB4BOR-1 can use this instance.",
|
||||||
),
|
),
|
||||||
cfg.StrOpt(
|
cfg.StrOpt(
|
||||||
"apiKey",
|
"apiKey",
|
||||||
help="Your twitter apiKey"
|
help="Your telegram apiKey"
|
||||||
"Information for creating your api keys is here: "
|
"Information for creating your api keys is here: "
|
||||||
"https://developer.twitter.com/en/docs/authentication/oauth-1-0a/api-key-and-secret",
|
"https://core.telegram.org/api/obtaining_api_id",
|
||||||
),
|
),
|
||||||
cfg.ListOpt(
|
cfg.ListOpt(
|
||||||
"shortcuts",
|
"shortcuts",
|
||||||
help="List of shortcuts for sending telegram messages "
|
help="List of shortcuts for sending telegram messages "
|
||||||
"For Exmaple: wb=hemna6969,cl=craigerl\n"
|
"For Example: wb=hemna6969,cl=craigerl\n"
|
||||||
"Means use 'wb' to send a telegram message to hemna6969",
|
"Means use 'wb' to send a telegram message to hemna6969",
|
||||||
),
|
),
|
||||||
]
|
]
|
||||||
|
Loading…
Reference in New Issue
Block a user