| Name | aprsd JSON |
| Version |
3.4.3
JSON |
| download |
| home_page | None |
| Summary | APRSd is a APRS-IS server that can be used to connect to APRS-IS and send and receive APRS packets. |
| upload_time | 2024-10-29 15:09:31 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. |
| keywords |
aprs
aprs-is
aprsd
aprsd-server
aprsd-client
aprsd-socket
aprsd-socket-server
aprsd-socket-client
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
aprslib
attrs
ax253
beautifulsoup4
bidict
bitarray
blinker
certifi
charset-normalizer
click
click-params
commonmark
dataclasses
dataclasses-json
debtcollector
deprecated
flask
flask-httpauth
flask-socketio
geographiclib
geopy
h11
idna
imapclient
importlib-metadata
itsdangerous
jinja2
kiss3
loguru
markupsafe
marshmallow
mypy-extensions
netaddr
oslo-config
oslo-i18n
packaging
pbr
pluggy
pygments
pyserial
pyserial-asyncio
python-engineio
python-socketio
pytz
pyyaml
requests
rfc3986
rich
rush
shellingham
simple-websocket
six
soupsieve
stevedore
tabulate
thesmuggler
typing-extensions
typing-inspect
tzlocal
update-checker
urllib3
validators
werkzeug
wrapt
wsproto
zipp
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
===============================================
APRSD - Ham radio APRS-IS Message plugin server
===============================================
KM6LYW and WB4BOR
____________________
|pypi| |pytest| |versions| |slack| |issues| |commit| |imports| |down|
`APRSD <http://github.com/craigerl/aprsd>`_ is a Ham radio `APRS <http://aprs.org>`_ message command gateway built on python.
What is APRSD
=============
APRSD is a python application for interacting with the APRS network and providing
APRS services for HAM radio operators.
APRSD currently has 4 main commands to use.
* server - Connect to APRS and listen/respond to APRS messages
* webchat - web based chat program over APRS
* send-message - Send a message to a callsign via APRS_IS.
* listen - Listen to packets on the APRS-IS Network based on FILTER.
Each of those commands can connect to the APRS-IS network if internet connectivity
is available. If internet is not available, then APRS can be configured to talk
to a TCP KISS TNC for radio connectivity.
Please `read the docs`_ to learn more!
APRSD Overview Diagram
======================
.. image:: https://raw.githubusercontent.com/craigerl/aprsd/master/docs/_static/aprsd_overview.svg?sanitize=true
Typical use case
================
APRSD's typical use case is that of providing an APRS wide service to all HAM
radio operators. For example the callsign 'REPEAT' on the APRS network is actually
an instance of APRSD that can provide a list of HAM repeaters in the area of the
callsign that sent the message.
Ham radio operator using an APRS enabled HAM radio sends a message to check
the weather. An APRS message is sent, and then picked up by APRSD. The
APRS packet is decoded, and the message is sent through the list of plugins
for processing. For example, the WeatherPlugin picks up the message, fetches the weather
for the area around the user who sent the request, and then responds with
the weather conditions in that area. Also includes a watch list of HAM
callsigns to look out for. The watch list can notify you when a HAM callsign
in the list is seen and now available to message on the APRS network.
Installation
=============
To install ``aprsd``, use Pip:
``pip install aprsd``
Example usage
==============
``aprsd -h``
Help
====
::
└─> aprsd -h
Usage: aprsd [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
-h, --help Show this message and exit.
Commands:
check-version Check this version against the latest in pypi.org.
completion Show the shell completion code
dev Development type subcommands
fetch-stats Fetch stats from a APRSD admin web interface.
healthcheck Check the health of the running aprsd server.
list-extensions List the built in plugins available to APRSD.
list-plugins List the built in plugins available to APRSD.
listen Listen to packets on the APRS-IS Network based on FILTER.
sample-config Generate a sample Config file from aprsd and all...
send-message Send a message to a callsign via APRS_IS.
server Start the aprsd server gateway process.
version Show the APRSD version.
webchat Web based HAM Radio chat program!
Commands
========
Configuration
=============
This command outputs a sample config yml formatted block that you can edit
and use to pass in to ``aprsd`` with ``-c``. By default aprsd looks in ``~/.config/aprsd/aprsd.yml``
``aprsd sample-config``
::
└─> aprsd sample-config
...
server
======
This is the main server command that will listen to APRS-IS servers and
look for incomming commands to the callsign configured in the config file
::
└─[$] > aprsd server --help
Usage: aprsd server [OPTIONS]
Start the aprsd server gateway process.
Options:
--loglevel [CRITICAL|ERROR|WARNING|INFO|DEBUG]
The log level to use for aprsd.log
[default: INFO]
-c, --config TEXT The aprsd config file to use for options.
[default:
/Users/i530566/.config/aprsd/aprsd.yml]
--quiet Don't log to stdout
-f, --flush Flush out all old aged messages on disk.
[default: False]
-h, --help Show this message and exit.
└─> aprsd server
Load config
12/07/2021 03:16:17 PM MainThread INFO APRSD is up to date server.py:51
12/07/2021 03:16:17 PM MainThread INFO APRSD Started version: 2.5.6 server.py:52
12/07/2021 03:16:17 PM MainThread INFO Using CONFIG values: server.py:55
12/07/2021 03:16:17 PM MainThread INFO ham.callsign = WB4BOR server.py:60
12/07/2021 03:16:17 PM MainThread INFO aprs.login = WB4BOR-12 server.py:60
12/07/2021 03:16:17 PM MainThread INFO aprs.password = XXXXXXXXXXXXXXXXXXX server.py:58
12/07/2021 03:16:17 PM MainThread INFO aprs.host = noam.aprs2.net server.py:60
12/07/2021 03:16:17 PM MainThread INFO aprs.port = 14580 server.py:60
12/07/2021 03:16:17 PM MainThread INFO aprs.logfile = /tmp/aprsd.log server.py:60
Current list of built-in plugins
======================================
::
└─> aprsd list-plugins
🐍 APRSD Built-in Plugins 🐍
┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Plugin Name ┃ Info ┃ Type ┃ Plugin Path ┃
┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ AVWXWeatherPlugin │ AVWX weather of GPS Beacon location │ RegexCommand │ aprsd.plugins.weather.AVWXWeatherPlugin │
│ EmailPlugin │ Send and Receive email │ RegexCommand │ aprsd.plugins.email.EmailPlugin │
│ FortunePlugin │ Give me a fortune │ RegexCommand │ aprsd.plugins.fortune.FortunePlugin │
│ LocationPlugin │ Where in the world is a CALLSIGN's last GPS beacon? │ RegexCommand │ aprsd.plugins.location.LocationPlugin │
│ NotifySeenPlugin │ Notify me when a CALLSIGN is recently seen on APRS-IS │ WatchList │ aprsd.plugins.notify.NotifySeenPlugin │
│ OWMWeatherPlugin │ OpenWeatherMap weather of GPS Beacon location │ RegexCommand │ aprsd.plugins.weather.OWMWeatherPlugin │
│ PingPlugin │ reply with a Pong! │ RegexCommand │ aprsd.plugins.ping.PingPlugin │
│ QueryPlugin │ APRSD Owner command to query messages in the MsgTrack │ RegexCommand │ aprsd.plugins.query.QueryPlugin │
│ TimeOWMPlugin │ Current time of GPS beacon's timezone. Uses OpenWeatherMap │ RegexCommand │ aprsd.plugins.time.TimeOWMPlugin │
│ TimePlugin │ What is the current local time. │ RegexCommand │ aprsd.plugins.time.TimePlugin │
│ USMetarPlugin │ USA only METAR of GPS Beacon location │ RegexCommand │ aprsd.plugins.weather.USMetarPlugin │
│ USWeatherPlugin │ Provide USA only weather of GPS Beacon location │ RegexCommand │ aprsd.plugins.weather.USWeatherPlugin │
│ VersionPlugin │ What is the APRSD Version │ RegexCommand │ aprsd.plugins.version.VersionPlugin │
└───────────────────┴────────────────────────────────────────────────────────────┴──────────────┴─────────────────────────────────────────┘
Pypi.org APRSD Installable Plugin Packages
Install any of the following plugins with 'pip install <Plugin Package Name>'
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ Plugin Package Name ┃ Description ┃ Version ┃ Released ┃ Installed? ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ 📂 aprsd-stock-plugin │ Ham Radio APRSD Plugin for fetching stock quotes │ 0.1.3 │ Dec 2, 2022 │ No │
│ 📂 aprsd-sentry-plugin │ Ham radio APRSD plugin that does.... │ 0.1.2 │ Dec 2, 2022 │ No │
│ 📂 aprsd-timeopencage-plugin │ APRSD plugin for fetching time based on GPS location │ 0.1.0 │ Dec 2, 2022 │ No │
│ 📂 aprsd-weewx-plugin │ HAM Radio APRSD that reports weather from a weewx weather station. │ 0.1.4 │ Dec 7, 2021 │ Yes │
│ 📂 aprsd-repeat-plugins │ APRSD Plugins for the REPEAT service │ 1.0.12 │ Dec 2, 2022 │ No │
│ 📂 aprsd-telegram-plugin │ Ham Radio APRS APRSD plugin for Telegram IM service │ 0.1.3 │ Dec 2, 2022 │ No │
│ 📂 aprsd-twitter-plugin │ Python APRSD plugin to send tweets │ 0.3.0 │ Dec 7, 2021 │ No │
│ 📂 aprsd-slack-plugin │ Amateur radio APRS daemon which listens for messages and responds │ 1.0.5 │ Dec 18, 2022 │ No │
└──────────────────────────────┴────────────────────────────────────────────────────────────────────┴─────────┴──────────────┴────────────┘
🐍 APRSD Installed 3rd party Plugins 🐍
┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Package Name ┃ Plugin Name ┃ Version ┃ Type ┃ Plugin Path ┃
┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ aprsd-weewx-plugin │ WeewxMQTTPlugin │ 1.0 │ RegexCommand │ aprsd_weewx_plugin.weewx.WeewxMQTTPlugin │
└────────────────────┴─────────────────┴─────────┴──────────────┴──────────────────────────────────────────┘
send-message
============
This command is typically used for development to send another aprsd instance
test messages
::
└─[$] > aprsd send-message -h
Usage: aprsd send-message [OPTIONS] TOCALLSIGN COMMAND...
Send a message to a callsign via APRS_IS.
Options:
--loglevel [CRITICAL|ERROR|WARNING|INFO|DEBUG]
The log level to use for aprsd.log
[default: INFO]
-c, --config TEXT The aprsd config file to use for options.
[default:
/Users/i530566/.config/aprsd/aprsd.yml]
--quiet Don't log to stdout
--aprs-login TEXT What callsign to send the message from.
[env var: APRS_LOGIN]
--aprs-password TEXT the APRS-IS password for APRS_LOGIN [env
var: APRS_PASSWORD]
-n, --no-ack Don't wait for an ack, just sent it to APRS-
IS and bail. [default: False]
-w, --wait-response Wait for a response to the message?
[default: False]
--raw TEXT Send a raw message. Implies --no-ack
-h, --help Show this message and exit.
SEND EMAIL (radio to smtp server)
=================================
::
Received message______________
Raw : KM6XXX>APY400,WIDE1-1,qAO,KM6XXX-1::KM6XXX-9 :-user@host.com test new shortcuts global, radio to pc{29
From : KM6XXX
Message : -user@host.com test new shortcuts global, radio to pc
Msg number : 29
Sending Email_________________
To : user@host.com
Subject : KM6XXX
Body : test new shortcuts global, radio to pc
Sending ack __________________ Tx(3)
Raw : KM6XXX-9>APRS::KM6XXX :ack29
To : KM6XXX
Ack number : 29
RECEIVE EMAIL (imap server to radio)
====================================
::
Sending message_______________ 6(Tx3)
Raw : KM6XXX-9>APRS::KM6XXX :-somebody@gmail.com email from internet to radio{6
To : KM6XXX
Message : -somebody@gmail.com email from internet to radio
Received message______________
Raw : KM6XXX>APY400,WIDE1-1,qAO,KM6XXX-1::KM6XXX-9 :ack6
From : KM6XXX
Message : ack6
Msg number : 0
LOCATION
========
::
Received Message _______________
Raw : KM6XXX-6>APRS,TCPIP*,qAC,T2CAEAST::KM6XXX-14:location{2
From : KM6XXX-6
Message : location
Msg number : 2
Received Message _______________ Complete
Sending Message _______________
Raw : KM6XXX-14>APRS::KM6XXX-6 :KM6XXX-6: 8 Miles E Auburn CA 0' 0,-120.93584 1873.7h ago{2
To : KM6XXX-6
Message : KM6XXX-6: 8 Miles E Auburn CA 0' 0,-120.93584 1873.7h ago
Msg number : 2
Sending Message _______________ Complete
Sending ack _______________
Raw : KM6XXX-14>APRS::KM6XXX-6 :ack2
To : KM6XXX-6
Ack : 2
Sending ack _______________ Complete
AND... ping, fortune, time.....
Web Admin Interface
===================
To start the web admin interface, You have to install gunicorn in your virtualenv that already has aprsd installed.
::
source <path to APRSD's virtualenv>/bin/activate
pip install gunicorn
gunicorn --bind 0.0.0.0:8080 "aprsd.wsgi:app"
The web admin interface will be running on port 8080 on the local machine. http://localhost:8080
Development
===========
* ``git clone git@github.com:craigerl/aprsd.git``
* ``cd aprsd``
* ``make``
Workflow
========
While working aprsd, The workflow is as follows:
* Checkout a new branch to work on by running
``git checkout -b mybranch``
* Make your changes to the code
* Run Tox with the following options:
- ``tox -epep8``
- ``tox -efmt``
- ``tox -p``
* Commit your changes. This will run the pre-commit hooks which does checks too
``git commit``
* Once you are done with all of your commits, then push up the branch to
github with:
``git push -u origin mybranch``
* Create a pull request from your branch so github tests can run and we can do
a code review.
Release
=======
To do release to pypi:
* Tag release with:
``git tag -v1.XX -m "New release"``
* Push release tag:
``git push origin master --tags``
* Do a test build and verify build is valid by running:
``make build``
* Once twine is happy, upload release to pypi:
``make upload``
Docker Container
================
Building
========
There are 2 versions of the container Dockerfile that can be used.
The main Dockerfile, which is for building the official release container
based off of the pip install version of aprsd and the Dockerfile-dev,
which is used for building a container based off of a git branch of
the repo.
Official Build
==============
``docker build -t hemna6969/aprsd:latest .``
Development Build
=================
``docker build -t hemna6969/aprsd:latest -f Dockerfile-dev .``
Running the container
=====================
There is a ``docker-compose.yml`` file in the ``docker/`` directory
that can be used to run your container. To provide the container
an ``aprsd.conf`` configuration file, change your
``docker-compose.yml`` as shown below:
::
volumes:
- $HOME/.config/aprsd:/config
To install plugins at container start time, pass in a list of
comma-separated list of plugins on PyPI using the ``APRSD_PLUGINS``
environment variable in the ``docker-compose.yml`` file. Note that
version constraints may also be provided. For example:
::
environment:
- APRSD_PLUGINS=aprsd-slack-plugin>=1.0.2,aprsd-twitter-plugin
.. badges
.. |pypi| image:: https://badge.fury.io/py/aprsd.svg
:target: https://badge.fury.io/py/aprsd
.. |pytest| image:: https://github.com/craigerl/aprsd/workflows/python/badge.svg
:target: https://github.com/craigerl/aprsd/actions
.. |versions| image:: https://img.shields.io/pypi/pyversions/aprsd.svg
:target: https://pypi.org/pypi/aprsd
.. |slack| image:: https://img.shields.io/badge/slack-@hemna/aprsd-blue.svg?logo=slack
:target: https://hemna.slack.com/app_redirect?channel=C01KQSCP5RP
.. |imports| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
:target: https://timothycrosley.github.io/isort/
.. |issues| image:: https://img.shields.io/github/issues/craigerl/aprsd
.. |commit| image:: https://img.shields.io/github/last-commit/craigerl/aprsd
.. |down| image:: https://static.pepy.tech/personalized-badge/aprsd?period=month&units=international_system&left_color=black&right_color=orange&left_text=Downloads
:target: https://pepy.tech/project/aprsd
.. links
.. _read the docs:
https://aprsd.readthedocs.io
Raw data
{
"_id": null,
"home_page": null,
"name": "aprsd",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Craig Lamparter <craig@craiger.org>, \"Walter A. Boring IV\" <waboring@hemna.com>",
"keywords": "aprs, aprs-is, aprsd, aprsd-server, aprsd-client, aprsd-socket, aprsd-socket-server, aprsd-socket-client",
"author": null,
"author_email": "Craig Lamparter <craig@craiger.org>, \"Walter A. Boring IV\" <waboring@hemna.com>, Emre Saglam <emresaglam@gmail.com>, Jason Martin <jhmartin@toger.us>, John <johng42@users.noreply.github.com>, Martiros Shakhzadyan <vrzh@vrzh.net>, Zoe Moore <zoenb@mailbox.org>, ranguli <hello@joshmurphy.ca>",
"download_url": "https://files.pythonhosted.org/packages/dc/7b/af80207783d012202371fb09366e9ff17beb89dde2cafd4a7deb80434120/aprsd-3.4.3.tar.gz",
"platform": null,
"description": "===============================================\nAPRSD - Ham radio APRS-IS Message plugin server\n===============================================\n\nKM6LYW and WB4BOR\n____________________\n\n|pypi| |pytest| |versions| |slack| |issues| |commit| |imports| |down|\n\n\n`APRSD <http://github.com/craigerl/aprsd>`_ is a Ham radio `APRS <http://aprs.org>`_ message command gateway built on python.\n\n\nWhat is APRSD\n=============\nAPRSD is a python application for interacting with the APRS network and providing\nAPRS services for HAM radio operators.\n\nAPRSD currently has 4 main commands to use.\n * server - Connect to APRS and listen/respond to APRS messages\n * webchat - web based chat program over APRS\n * send-message - Send a message to a callsign via APRS_IS.\n * listen - Listen to packets on the APRS-IS Network based on FILTER.\n\nEach of those commands can connect to the APRS-IS network if internet connectivity\nis available. If internet is not available, then APRS can be configured to talk\nto a TCP KISS TNC for radio connectivity.\n\nPlease `read the docs`_ to learn more!\n\nAPRSD Overview Diagram\n======================\n\n.. image:: https://raw.githubusercontent.com/craigerl/aprsd/master/docs/_static/aprsd_overview.svg?sanitize=true\n\nTypical use case\n================\n\nAPRSD's typical use case is that of providing an APRS wide service to all HAM\nradio operators. For example the callsign 'REPEAT' on the APRS network is actually\nan instance of APRSD that can provide a list of HAM repeaters in the area of the\ncallsign that sent the message.\n\n\nHam radio operator using an APRS enabled HAM radio sends a message to check\nthe weather. An APRS message is sent, and then picked up by APRSD. The\nAPRS packet is decoded, and the message is sent through the list of plugins\nfor processing. For example, the WeatherPlugin picks up the message, fetches the weather\nfor the area around the user who sent the request, and then responds with\nthe weather conditions in that area. Also includes a watch list of HAM\ncallsigns to look out for. The watch list can notify you when a HAM callsign\nin the list is seen and now available to message on the APRS network.\n\n\n\nInstallation\n=============\n\nTo install ``aprsd``, use Pip:\n\n``pip install aprsd``\n\nExample usage\n==============\n\n``aprsd -h``\n\nHelp\n====\n::\n\n\n \u2514\u2500> aprsd -h\n Usage: aprsd [OPTIONS] COMMAND [ARGS]...\n\n Options:\n --version Show the version and exit.\n -h, --help Show this message and exit.\n\n Commands:\n check-version Check this version against the latest in pypi.org.\n completion Show the shell completion code\n dev Development type subcommands\n fetch-stats Fetch stats from a APRSD admin web interface.\n healthcheck Check the health of the running aprsd server.\n list-extensions List the built in plugins available to APRSD.\n list-plugins List the built in plugins available to APRSD.\n listen Listen to packets on the APRS-IS Network based on FILTER.\n sample-config Generate a sample Config file from aprsd and all...\n send-message Send a message to a callsign via APRS_IS.\n server Start the aprsd server gateway process.\n version Show the APRSD version.\n webchat Web based HAM Radio chat program!\n\n\nCommands\n========\n\nConfiguration\n=============\nThis command outputs a sample config yml formatted block that you can edit\nand use to pass in to ``aprsd`` with ``-c``. By default aprsd looks in ``~/.config/aprsd/aprsd.yml``\n\n``aprsd sample-config``\n\n::\n\n \u2514\u2500> aprsd sample-config\n ...\n\nserver\n======\n\nThis is the main server command that will listen to APRS-IS servers and\nlook for incomming commands to the callsign configured in the config file\n\n::\n\n \u2514\u2500[$] > aprsd server --help\n Usage: aprsd server [OPTIONS]\n\n Start the aprsd server gateway process.\n\n Options:\n --loglevel [CRITICAL|ERROR|WARNING|INFO|DEBUG]\n The log level to use for aprsd.log\n [default: INFO]\n -c, --config TEXT The aprsd config file to use for options.\n [default:\n /Users/i530566/.config/aprsd/aprsd.yml]\n --quiet Don't log to stdout\n -f, --flush Flush out all old aged messages on disk.\n [default: False]\n -h, --help Show this message and exit.\n\n \u2514\u2500> aprsd server\n Load config\n 12/07/2021 03:16:17 PM MainThread INFO APRSD is up to date server.py:51\n 12/07/2021 03:16:17 PM MainThread INFO APRSD Started version: 2.5.6 server.py:52\n 12/07/2021 03:16:17 PM MainThread INFO Using CONFIG values: server.py:55\n 12/07/2021 03:16:17 PM MainThread INFO ham.callsign = WB4BOR server.py:60\n 12/07/2021 03:16:17 PM MainThread INFO aprs.login = WB4BOR-12 server.py:60\n 12/07/2021 03:16:17 PM MainThread INFO aprs.password = XXXXXXXXXXXXXXXXXXX server.py:58\n 12/07/2021 03:16:17 PM MainThread INFO aprs.host = noam.aprs2.net server.py:60\n 12/07/2021 03:16:17 PM MainThread INFO aprs.port = 14580 server.py:60\n 12/07/2021 03:16:17 PM MainThread INFO aprs.logfile = /tmp/aprsd.log server.py:60\n\n\nCurrent list of built-in plugins\n======================================\n\n::\n\n \u2514\u2500> aprsd list-plugins\n \ud83d\udc0d APRSD Built-in Plugins \ud83d\udc0d\n \u250f\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2513\n \u2503 Plugin Name \u2503 Info \u2503 Type \u2503 Plugin Path \u2503\n \u2521\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2529\n \u2502 AVWXWeatherPlugin \u2502 AVWX weather of GPS Beacon location \u2502 RegexCommand \u2502 aprsd.plugins.weather.AVWXWeatherPlugin \u2502\n \u2502 EmailPlugin \u2502 Send and Receive email \u2502 RegexCommand \u2502 aprsd.plugins.email.EmailPlugin \u2502\n \u2502 FortunePlugin \u2502 Give me a fortune \u2502 RegexCommand \u2502 aprsd.plugins.fortune.FortunePlugin \u2502\n \u2502 LocationPlugin \u2502 Where in the world is a CALLSIGN's last GPS beacon? \u2502 RegexCommand \u2502 aprsd.plugins.location.LocationPlugin \u2502\n \u2502 NotifySeenPlugin \u2502 Notify me when a CALLSIGN is recently seen on APRS-IS \u2502 WatchList \u2502 aprsd.plugins.notify.NotifySeenPlugin \u2502\n \u2502 OWMWeatherPlugin \u2502 OpenWeatherMap weather of GPS Beacon location \u2502 RegexCommand \u2502 aprsd.plugins.weather.OWMWeatherPlugin \u2502\n \u2502 PingPlugin \u2502 reply with a Pong! \u2502 RegexCommand \u2502 aprsd.plugins.ping.PingPlugin \u2502\n \u2502 QueryPlugin \u2502 APRSD Owner command to query messages in the MsgTrack \u2502 RegexCommand \u2502 aprsd.plugins.query.QueryPlugin \u2502\n \u2502 TimeOWMPlugin \u2502 Current time of GPS beacon's timezone. Uses OpenWeatherMap \u2502 RegexCommand \u2502 aprsd.plugins.time.TimeOWMPlugin \u2502\n \u2502 TimePlugin \u2502 What is the current local time. \u2502 RegexCommand \u2502 aprsd.plugins.time.TimePlugin \u2502\n \u2502 USMetarPlugin \u2502 USA only METAR of GPS Beacon location \u2502 RegexCommand \u2502 aprsd.plugins.weather.USMetarPlugin \u2502\n \u2502 USWeatherPlugin \u2502 Provide USA only weather of GPS Beacon location \u2502 RegexCommand \u2502 aprsd.plugins.weather.USWeatherPlugin \u2502\n \u2502 VersionPlugin \u2502 What is the APRSD Version \u2502 RegexCommand \u2502 aprsd.plugins.version.VersionPlugin \u2502\n \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\n\n Pypi.org APRSD Installable Plugin Packages\n\n Install any of the following plugins with 'pip install <Plugin Package Name>'\n \u250f\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2513\n \u2503 Plugin Package Name \u2503 Description \u2503 Version \u2503 Released \u2503 Installed? \u2503\n \u2521\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2529\n \u2502 \ud83d\udcc2 aprsd-stock-plugin \u2502 Ham Radio APRSD Plugin for fetching stock quotes \u2502 0.1.3 \u2502 Dec 2, 2022 \u2502 No \u2502\n \u2502 \ud83d\udcc2 aprsd-sentry-plugin \u2502 Ham radio APRSD plugin that does.... \u2502 0.1.2 \u2502 Dec 2, 2022 \u2502 No \u2502\n \u2502 \ud83d\udcc2 aprsd-timeopencage-plugin \u2502 APRSD plugin for fetching time based on GPS location \u2502 0.1.0 \u2502 Dec 2, 2022 \u2502 No \u2502\n \u2502 \ud83d\udcc2 aprsd-weewx-plugin \u2502 HAM Radio APRSD that reports weather from a weewx weather station. \u2502 0.1.4 \u2502 Dec 7, 2021 \u2502 Yes \u2502\n \u2502 \ud83d\udcc2 aprsd-repeat-plugins \u2502 APRSD Plugins for the REPEAT service \u2502 1.0.12 \u2502 Dec 2, 2022 \u2502 No \u2502\n \u2502 \ud83d\udcc2 aprsd-telegram-plugin \u2502 Ham Radio APRS APRSD plugin for Telegram IM service \u2502 0.1.3 \u2502 Dec 2, 2022 \u2502 No \u2502\n \u2502 \ud83d\udcc2 aprsd-twitter-plugin \u2502 Python APRSD plugin to send tweets \u2502 0.3.0 \u2502 Dec 7, 2021 \u2502 No \u2502\n \u2502 \ud83d\udcc2 aprsd-slack-plugin \u2502 Amateur radio APRS daemon which listens for messages and responds \u2502 1.0.5 \u2502 Dec 18, 2022 \u2502 No \u2502\n \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\n\n \ud83d\udc0d APRSD Installed 3rd party Plugins \ud83d\udc0d\n \u250f\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2513\n \u2503 Package Name \u2503 Plugin Name \u2503 Version \u2503 Type \u2503 Plugin Path \u2503\n \u2521\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2529\n \u2502 aprsd-weewx-plugin \u2502 WeewxMQTTPlugin \u2502 1.0 \u2502 RegexCommand \u2502 aprsd_weewx_plugin.weewx.WeewxMQTTPlugin \u2502\n \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\n\n\nsend-message\n============\n\nThis command is typically used for development to send another aprsd instance\ntest messages\n\n::\n\n \u2514\u2500[$] > aprsd send-message -h\n Usage: aprsd send-message [OPTIONS] TOCALLSIGN COMMAND...\n\n Send a message to a callsign via APRS_IS.\n\n Options:\n --loglevel [CRITICAL|ERROR|WARNING|INFO|DEBUG]\n The log level to use for aprsd.log\n [default: INFO]\n -c, --config TEXT The aprsd config file to use for options.\n [default:\n /Users/i530566/.config/aprsd/aprsd.yml]\n --quiet Don't log to stdout\n --aprs-login TEXT What callsign to send the message from.\n [env var: APRS_LOGIN]\n --aprs-password TEXT the APRS-IS password for APRS_LOGIN [env\n var: APRS_PASSWORD]\n -n, --no-ack Don't wait for an ack, just sent it to APRS-\n IS and bail. [default: False]\n -w, --wait-response Wait for a response to the message?\n [default: False]\n --raw TEXT Send a raw message. Implies --no-ack\n -h, --help Show this message and exit.\n\n\nSEND EMAIL (radio to smtp server)\n=================================\n\n::\n\n Received message______________\n Raw : KM6XXX>APY400,WIDE1-1,qAO,KM6XXX-1::KM6XXX-9 :-user@host.com test new shortcuts global, radio to pc{29\n From : KM6XXX\n Message : -user@host.com test new shortcuts global, radio to pc\n Msg number : 29\n\n Sending Email_________________\n To : user@host.com\n Subject : KM6XXX\n Body : test new shortcuts global, radio to pc\n\n Sending ack __________________ Tx(3)\n Raw : KM6XXX-9>APRS::KM6XXX :ack29\n To : KM6XXX\n Ack number : 29\n\n\nRECEIVE EMAIL (imap server to radio)\n====================================\n\n::\n\n Sending message_______________ 6(Tx3)\n Raw : KM6XXX-9>APRS::KM6XXX :-somebody@gmail.com email from internet to radio{6\n To : KM6XXX\n Message : -somebody@gmail.com email from internet to radio\n\n Received message______________\n Raw : KM6XXX>APY400,WIDE1-1,qAO,KM6XXX-1::KM6XXX-9 :ack6\n From : KM6XXX\n Message : ack6\n Msg number : 0\n\n\nLOCATION\n========\n\n::\n\n Received Message _______________\n Raw : KM6XXX-6>APRS,TCPIP*,qAC,T2CAEAST::KM6XXX-14:location{2\n From : KM6XXX-6\n Message : location\n Msg number : 2\n Received Message _______________ Complete\n\n Sending Message _______________\n Raw : KM6XXX-14>APRS::KM6XXX-6 :KM6XXX-6: 8 Miles E Auburn CA 0' 0,-120.93584 1873.7h ago{2\n To : KM6XXX-6\n Message : KM6XXX-6: 8 Miles E Auburn CA 0' 0,-120.93584 1873.7h ago\n Msg number : 2\n Sending Message _______________ Complete\n\n Sending ack _______________\n Raw : KM6XXX-14>APRS::KM6XXX-6 :ack2\n To : KM6XXX-6\n Ack : 2\n Sending ack _______________ Complete\n\nAND... ping, fortune, time.....\n\n\nWeb Admin Interface\n===================\nTo start the web admin interface, You have to install gunicorn in your virtualenv that already has aprsd installed.\n\n::\n\n source <path to APRSD's virtualenv>/bin/activate\n pip install gunicorn\n gunicorn --bind 0.0.0.0:8080 \"aprsd.wsgi:app\"\n\nThe web admin interface will be running on port 8080 on the local machine. http://localhost:8080\n\n\n\nDevelopment\n===========\n\n* ``git clone git@github.com:craigerl/aprsd.git``\n* ``cd aprsd``\n* ``make``\n\nWorkflow\n========\n\nWhile working aprsd, The workflow is as follows:\n\n* Checkout a new branch to work on by running\n\n ``git checkout -b mybranch``\n\n* Make your changes to the code\n* Run Tox with the following options:\n\n - ``tox -epep8``\n - ``tox -efmt``\n - ``tox -p``\n\n* Commit your changes. This will run the pre-commit hooks which does checks too\n\n ``git commit``\n\n* Once you are done with all of your commits, then push up the branch to\n github with:\n\n ``git push -u origin mybranch``\n\n* Create a pull request from your branch so github tests can run and we can do\n a code review.\n\n\nRelease\n=======\n\nTo do release to pypi:\n\n* Tag release with:\n\n ``git tag -v1.XX -m \"New release\"``\n\n* Push release tag:\n\n ``git push origin master --tags``\n\n* Do a test build and verify build is valid by running:\n\n ``make build``\n\n* Once twine is happy, upload release to pypi:\n\n ``make upload``\n\n\nDocker Container\n================\n\nBuilding\n========\n\nThere are 2 versions of the container Dockerfile that can be used.\nThe main Dockerfile, which is for building the official release container\nbased off of the pip install version of aprsd and the Dockerfile-dev,\nwhich is used for building a container based off of a git branch of\nthe repo.\n\nOfficial Build\n==============\n\n``docker build -t hemna6969/aprsd:latest .``\n\nDevelopment Build\n=================\n\n``docker build -t hemna6969/aprsd:latest -f Dockerfile-dev .``\n\n\nRunning the container\n=====================\n\nThere is a ``docker-compose.yml`` file in the ``docker/`` directory\nthat can be used to run your container. To provide the container\nan ``aprsd.conf`` configuration file, change your\n``docker-compose.yml`` as shown below:\n\n::\n\n volumes:\n - $HOME/.config/aprsd:/config\n\nTo install plugins at container start time, pass in a list of\ncomma-separated list of plugins on PyPI using the ``APRSD_PLUGINS``\nenvironment variable in the ``docker-compose.yml`` file. Note that\nversion constraints may also be provided. For example:\n\n::\n\n environment:\n - APRSD_PLUGINS=aprsd-slack-plugin>=1.0.2,aprsd-twitter-plugin\n\n\n.. badges\n\n.. |pypi| image:: https://badge.fury.io/py/aprsd.svg\n :target: https://badge.fury.io/py/aprsd\n\n.. |pytest| image:: https://github.com/craigerl/aprsd/workflows/python/badge.svg\n :target: https://github.com/craigerl/aprsd/actions\n\n.. |versions| image:: https://img.shields.io/pypi/pyversions/aprsd.svg\n :target: https://pypi.org/pypi/aprsd\n\n.. |slack| image:: https://img.shields.io/badge/slack-@hemna/aprsd-blue.svg?logo=slack\n :target: https://hemna.slack.com/app_redirect?channel=C01KQSCP5RP\n\n.. |imports| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336\n :target: https://timothycrosley.github.io/isort/\n\n.. |issues| image:: https://img.shields.io/github/issues/craigerl/aprsd\n\n.. |commit| image:: https://img.shields.io/github/last-commit/craigerl/aprsd\n\n.. |down| image:: https://static.pepy.tech/personalized-badge/aprsd?period=month&units=international_system&left_color=black&right_color=orange&left_text=Downloads\n :target: https://pepy.tech/project/aprsd\n\n.. links\n.. _read the docs:\n https://aprsd.readthedocs.io\n",
"bugtrack_url": null,
"license": " Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License. \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\" \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. ",
"summary": "APRSd is a APRS-IS server that can be used to connect to APRS-IS and send and receive APRS packets.",
"version": "3.4.3",
"project_urls": {
"Bug Reports": "https://github.com/craigerl/aprsd/issues",
"Homepage": "https://github.com/craigerl/aprsd",
"Source": "https://github.com/craigerl/aprsd"
},
"split_keywords": [
"aprs",
" aprs-is",
" aprsd",
" aprsd-server",
" aprsd-client",
" aprsd-socket",
" aprsd-socket-server",
" aprsd-socket-client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6ab46959ef62827fab6b3b55c887ccdb0bbec99488fcbc6f3e063c812df7c821",
"md5": "106a483b15ec49a2607ebec7362c84bc",
"sha256": "390f0c9c60271f13a7691bead413308a24868cd3b76a7e05c9dc617ea3981a1c"
},
"downloads": -1,
"filename": "aprsd-3.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "106a483b15ec49a2607ebec7362c84bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2342591,
"upload_time": "2024-10-29T15:09:29",
"upload_time_iso_8601": "2024-10-29T15:09:29.209997Z",
"url": "https://files.pythonhosted.org/packages/6a/b4/6959ef62827fab6b3b55c887ccdb0bbec99488fcbc6f3e063c812df7c821/aprsd-3.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dc7baf80207783d012202371fb09366e9ff17beb89dde2cafd4a7deb80434120",
"md5": "098724231e4fdccee2a27691fd2c759d",
"sha256": "d056eb224aa530a567c6d09de5d5f573493a0a2de34adde0b7f163b0a775f27c"
},
"downloads": -1,
"filename": "aprsd-3.4.3.tar.gz",
"has_sig": false,
"md5_digest": "098724231e4fdccee2a27691fd2c759d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2520143,
"upload_time": "2024-10-29T15:09:31",
"upload_time_iso_8601": "2024-10-29T15:09:31.928638Z",
"url": "https://files.pythonhosted.org/packages/dc/7b/af80207783d012202371fb09366e9ff17beb89dde2cafd4a7deb80434120/aprsd-3.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-29 15:09:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "craigerl",
"github_project": "aprsd",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "aprslib",
"specs": [
[
"==",
"0.7.2"
]
]
},
{
"name": "attrs",
"specs": [
[
"==",
"24.2.0"
]
]
},
{
"name": "ax253",
"specs": [
[
"==",
"0.1.5.post1"
]
]
},
{
"name": "beautifulsoup4",
"specs": [
[
"==",
"4.12.3"
]
]
},
{
"name": "bidict",
"specs": [
[
"==",
"0.23.1"
]
]
},
{
"name": "bitarray",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "blinker",
"specs": [
[
"==",
"1.8.2"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2024.8.30"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.4.0"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.7"
]
]
},
{
"name": "click-params",
"specs": [
[
"==",
"0.5.0"
]
]
},
{
"name": "commonmark",
"specs": [
[
"==",
"0.9.1"
]
]
},
{
"name": "dataclasses",
"specs": [
[
"==",
"0.6"
]
]
},
{
"name": "dataclasses-json",
"specs": [
[
"==",
"0.6.7"
]
]
},
{
"name": "debtcollector",
"specs": [
[
"==",
"3.0.0"
]
]
},
{
"name": "deprecated",
"specs": [
[
"==",
"1.2.14"
]
]
},
{
"name": "flask",
"specs": [
[
"==",
"3.0.3"
]
]
},
{
"name": "flask-httpauth",
"specs": [
[
"==",
"4.8.0"
]
]
},
{
"name": "flask-socketio",
"specs": [
[
"==",
"5.4.1"
]
]
},
{
"name": "geographiclib",
"specs": [
[
"==",
"2.0"
]
]
},
{
"name": "geopy",
"specs": [
[
"==",
"2.4.1"
]
]
},
{
"name": "h11",
"specs": [
[
"==",
"0.14.0"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.10"
]
]
},
{
"name": "imapclient",
"specs": [
[
"==",
"3.0.1"
]
]
},
{
"name": "importlib-metadata",
"specs": [
[
"==",
"8.5.0"
]
]
},
{
"name": "itsdangerous",
"specs": [
[
"==",
"2.2.0"
]
]
},
{
"name": "jinja2",
"specs": [
[
"==",
"3.1.4"
]
]
},
{
"name": "kiss3",
"specs": [
[
"==",
"8.0.0"
]
]
},
{
"name": "loguru",
"specs": [
[
"==",
"0.7.2"
]
]
},
{
"name": "markupsafe",
"specs": [
[
"==",
"3.0.2"
]
]
},
{
"name": "marshmallow",
"specs": [
[
"==",
"3.23.0"
]
]
},
{
"name": "mypy-extensions",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "netaddr",
"specs": [
[
"==",
"1.3.0"
]
]
},
{
"name": "oslo-config",
"specs": [
[
"==",
"9.6.0"
]
]
},
{
"name": "oslo-i18n",
"specs": [
[
"==",
"6.4.0"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"24.1"
]
]
},
{
"name": "pbr",
"specs": [
[
"==",
"6.1.0"
]
]
},
{
"name": "pluggy",
"specs": [
[
"==",
"1.5.0"
]
]
},
{
"name": "pygments",
"specs": [
[
"==",
"2.18.0"
]
]
},
{
"name": "pyserial",
"specs": [
[
"==",
"3.5"
]
]
},
{
"name": "pyserial-asyncio",
"specs": [
[
"==",
"0.6"
]
]
},
{
"name": "python-engineio",
"specs": [
[
"==",
"4.10.1"
]
]
},
{
"name": "python-socketio",
"specs": [
[
"==",
"5.11.4"
]
]
},
{
"name": "pytz",
"specs": [
[
"==",
"2024.2"
]
]
},
{
"name": "pyyaml",
"specs": [
[
"==",
"6.0.2"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.32.3"
]
]
},
{
"name": "rfc3986",
"specs": [
[
"==",
"2.0.0"
]
]
},
{
"name": "rich",
"specs": [
[
"==",
"12.6.0"
]
]
},
{
"name": "rush",
"specs": [
[
"==",
"2021.4.0"
]
]
},
{
"name": "shellingham",
"specs": [
[
"==",
"1.5.4"
]
]
},
{
"name": "simple-websocket",
"specs": [
[
"==",
"1.1.0"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "soupsieve",
"specs": [
[
"==",
"2.6"
]
]
},
{
"name": "stevedore",
"specs": [
[
"==",
"5.3.0"
]
]
},
{
"name": "tabulate",
"specs": [
[
"==",
"0.9.0"
]
]
},
{
"name": "thesmuggler",
"specs": [
[
"==",
"1.0.1"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
"==",
"4.12.2"
]
]
},
{
"name": "typing-inspect",
"specs": [
[
"==",
"0.9.0"
]
]
},
{
"name": "tzlocal",
"specs": [
[
"==",
"5.2"
]
]
},
{
"name": "update-checker",
"specs": [
[
"==",
"0.18.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.2.3"
]
]
},
{
"name": "validators",
"specs": [
[
"==",
"0.22.0"
]
]
},
{
"name": "werkzeug",
"specs": [
[
"==",
"3.0.4"
]
]
},
{
"name": "wrapt",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "wsproto",
"specs": [
[
"==",
"1.2.0"
]
]
},
{
"name": "zipp",
"specs": [
[
"==",
"3.20.2"
]
]
}
],
"tox": true,
"lcname": "aprsd"
}
