An LLM-based assistant for the Automatic Packet Reporting System (APRS).
Project description
APRS Assistant
An LLM-based assistant for the Automatic Packet Reporting System (APRS).
Note: This library provides core functionality for an LLM-based APRS chatbot, but does not itself directly handle APRS messaging (RX, or TX). For this, a library like apsd is needed. Instructions for connecting the assistant to the APRS network are forthcoming in a future update.
Installation
pip install aprs-assistant
Callsign
Your bot needs a callsign! Set with the APRS_ASSISTANT_CALLSIGN
environment variable.
export APRS_ASSISTANT_CALLSIGN=<CLEVER_CALLSIGN>
API Keys
At a minimum, this library requires setting an OpenAI API key. Bing and APRS.fi API keys are also used to support various tools and services. Set the, as environment variable in bash, as follows:
export OPENAI_API_KEY=<YOUR_KEY>
export BING_API_KEY=<YOUR_KEY>
export APRSFI_API_KEY=<YOUR_KEY>
Running Local Chat
The library supports local chats (e.g., for debugging) as follows:
python -m aprs-assistant <YOUR_CALLSIGN>
Type exit
or press Ctrl-D
to exit.
Integration
To integrate aprs-assistant
into your application, simply use:
from aprs_assistant import generate_reply
sender_callsign = "NOCALL"
message = "What's the weather?"
response = generate_reply(sender_callsign, message)
print(response)
Note: response
can be None
License
aprs-assistant
is distributed under the terms of the MIT license.
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
Built Distribution
File details
Details for the file aprs_assistant-0.0.2.tar.gz
.
File metadata
- Download URL: aprs_assistant-0.0.2.tar.gz
- Upload date:
- Size: 12.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.26.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72d65806cf8434fcaa7bdae3056ad3fc01486813f8e95a94ce95695289eabb02 |
|
MD5 | 150781c56b1122f3f6546b29fb711973 |
|
BLAKE2b-256 | 38f428163bc9223be4642a1f312f1bb076d4439d54c369bd950143a28aaa835c |
File details
Details for the file aprs_assistant-0.0.2-py3-none-any.whl
.
File metadata
- Download URL: aprs_assistant-0.0.2-py3-none-any.whl
- Upload date:
- Size: 15.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.26.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2710848c5133878a98436f2ff25233cc425f2bd4d51d454cd91bf8370eb138fb |
|
MD5 | 2cc8d68ca1a98da2d7b729bf3a49384d |
|
BLAKE2b-256 | c5db34cf8508989ae31de1e66b7bb7dc51b1c3222583c630b896764ce4d08ec3 |