Skip to content

hemna/aprsd-rich-cli-extension

Repository files navigation

APRSD CLI UI

PyPI Status Python Version [License](https://opensource.org/licenses/Apache Software License 2.0)

Read the documentation at https://aprsd-rich-cli-extension.readthedocs.io/ Tests Codecov

pre-commit


Warning

Legal operation of this software requires an amateur radio license and a valid call sign.

Note

Star this repo to follow our progress! This code is under active development, and contributions are both welcomed and appreciated. See CONTRIBUTING.md for details.

What is APRSD Rich CLI Extension?

APRSD Rich CLI Extension provides beautiful, interactive terminal UI versions of APRSD commands using the Textual library. This extension transforms the traditional command-line APRS experience into a modern, user-friendly interface.

Features

The extension provides rich terminal UIs for:

  • APRS Chat - An interactive chat interface for sending and receiving APRS messages in real-time
  • APRS Listen - A live packet monitor showing incoming APRS packets with detailed information
  • Packet Filtering - Advanced filtering and search capabilities
  • Real-time Updates - Live updates as packets are received

Screenshot

Requirements

  • Python >=3.10
  • APRSD >=4.2.0
  • Textual (installed automatically)

Installation

You can install APRSD CLI UI via pip from PyPI or using uv:

$ pip install aprsd-rich-cli-extension

or with uv:

$ uv pip install aprsd-rich-cli-extension

Usage

Once installed, the extension adds new subcommands to the aprsd CLI:

  • aprsd chat - Launch the interactive APRS chat interface
  • aprsd listen - Launch the live APRS packet listener

You can use the built-in help to see all available options:

$ aprsd chat --help
$ aprsd listen --help

For more detailed usage information, please see the Command-line Reference.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the [Apache Software License 2.0 license](https://opensource.org/licenses/Apache Software License 2.0), APRSD CLI UI 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 Extension Python Cookiecutter template.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published