Skip to main content

APRSd plugin for hosting the APRS Assistant chatbot (aprs-assistant)

Project description

APRSD Assistant Plugin

PyPI - Version PyPI - Python Version

The APRS Assistant is an LLM-based assistant for the Automatic Packet Reporting System (APRS). However, the Assistant can't connect to the APRS IS network on its own -- it needs to live in an APRS server or host.

As the name suggests, this aprsd-assistant-plugin one such host container for the APRSd server.

[!TIP] This package includes both aprsd and aprs-assistant as dependencies, and should be the only package that you need to pip install and configure to get up and running. Read on!


Installation

pip install aprsd-assistant-plugin

Configuration

APRSd has many advanced configuration options, but only some are relevant for running the APRS Assistant. The following is a minimal configuration for getting up and running. Be sure to write this to the file ~/.config/aprsd/aprsd.conf:

[DEFAULT]
callsign = <YOUR_BOTS_CALLSIGN>
enabled_plugins = aprsd_assistant_plugin.AssistantPlugin

[aprs_fi]
# Get the apiKey from your aprs.fi account here:http://aprs.fi/account
# (string value)
apiKey = <YOUR_APRS_FI_API_KEY>

[aprs_network]
enabled = true

# APRS IS Username (string value)
login = <YOUR_BOTS_CALLSIGN>

# APRS IS Password Get the passcode for your callsign here:
# https://apps.magicbug.co.uk/passcode (string value)
password = <PASSWORD_GENERATED_FOR_BOTS_CALLSIGN>

[aprsd_assistant_plugin]
enabled = true

# (Required) OpenAI API key form making the LLM calls
openai_api_key = <YOUR_OPENAI_API_KEY>

# (Optional) Bing API key for web search and new results
# bing_api_key = <YOUR_BING_API_KEY>

Running the Assistant

Once the config file is in place, run:

aprsd server

If you've saved the aprsd.conf file somewhere else, use:

aprsd server -c <path to aprsd.conf>

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_assistant_plugin-0.0.1.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

aprsd_assistant_plugin-0.0.1-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file aprsd_assistant_plugin-0.0.1.tar.gz.

File metadata

File hashes

Hashes for aprsd_assistant_plugin-0.0.1.tar.gz
Algorithm Hash digest
SHA256 1117ae1ec43ea9d0508d1fb79d9c115d708225c175fca0441cf989361bbf41bf
MD5 147761ad68b0b1d0d6e48a501639b675
BLAKE2b-256 733871b587aa8d521e5701744b898d021107e6f18992eeef4dd29aaa3cc16a9d

See more details on using hashes here.

File details

Details for the file aprsd_assistant_plugin-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for aprsd_assistant_plugin-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 719ea0c5f5d94f3616c8f7f232229d099ebeefb2a251f2d519b3c7f0a2b574a7
MD5 b9296c5c04c6194dd58572ff42578732
BLAKE2b-256 98d6e064722008619f9ab546d5cf8dd2c6579f530a73ec47840585110c56355b

See more details on using hashes here.

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