Metadata-Version: 2.3
Name: hamkit
Version: 0.0.1a4
Summary: A command-line interface for various ham radio tools.
Project-URL: Documentation, https://github.com/afourney/hamkit/blob/main/README.md
Project-URL: Issues, https://github.com/afourney/hamkit/issues
Project-URL: Source, https://github.com/afourney/hamkit/
Author-email: Adam Fourney <adam.fourney@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.10
Requires-Dist: hamkit-itu
Requires-Dist: hamkit-repeaterbook
Requires-Dist: hamkit-uls
Description-Content-Type: text/markdown

# HamKit

[![PyPI - Version](https://img.shields.io/pypi/v/hamkit.svg)](https://pypi.org/project/hamkit)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hamkit.svg)](https://pypi.org/project/hamkit)

---

The `hamkit` package installs ALL `HamKit` submodules, and provides a command-line interface to demonstrate HamKit functionality.

```console
pip install hamkit
```

At present, HamKit includes the following submodules:

| Package                                                | Version                                                           | Description                                                                        |
| ------------------------------------------------------ | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| [itu_prefixes](https://pypi.org/project/itu-prefixes/) | ![PyPI - Version](https://img.shields.io/pypi/v/itu-prefixes.svg) | Tools for working with ITU call sign prefixes (e.g., to look up country of origin) |

## Command-line Interface

`hamkit` provides a command-line interface to demonstrate HamKit functionality. Invoke it as follows:

```console
Syntax:
python -m hamkit COMMAND [ARGS..]

Available commands, and their arguments:

    help                   show *this* help message

    itu_prefixes [QUERY],  where QUERY is a call sign, prefix, or 2-letter
                           country code (e.g., itu_prefixes KK7CMT)
```

For example:

```
user@HOST:~$ python -m hamkit itu_prefixes KK7CMT

SUBROUTINE: call_sign_to_country('KK7CMT'):
If KK7CM is a call sign, then it was likely issued by:

  ITU Prefix: K
  Country Name: United States
  Country Code: US
```

## License

`hamkit` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
