Skip to content

ak7vv/hamframe

Repository files navigation

A Framework for Ham Radio

GitHub Actions Workflow Status for CLI build
GitHub Actions Workflow Status for API build
GitHub issues current open count
GitHub commit activity per month (main branch)

Intro

This repo contains an experimental framework for automating the workflow of an amateur radio operator (ham). This work is currently in the early stages and probably not terribly useful as-is. The goal is to develop a disaggregated software stack that allows the end user to easily tailor the specific structure to a particular need by removing, modifying, or adding components.

You can read more about some of my thoughts here, which may or may not be in sync with this repo. ¯\_(ツ)_/¯ But they may explain some of the insanity behind this well-intentioned effort.

Further reading:

Repo layout

├── api
│   ├── api.py
│   ├── Dockerfile
│   ├── README.md
│   ├── requirements.txt
│   ├── routers
│   │   └── configuration
│   │       ├── operations.py
│   │       ├── get.py
│   │       ├── put.py
│   │       ├── patch.py
│   │       └── delete.py
│   └── tests
│       └── test_api.py
├── cli
│   ├── cli.py
│   ├── Dockerfile
│   ├── Makefile
│   └── requirements.txt
├── config
│   ├── ak7vv
│   │   └── ..
│   └── instance_name
│       ├── clublog.toml
│       ├── couchbase.toml
│       ├── hamframe.toml
│       ├── n0nbh.toml
│       ├── qrz.toml
│       ├── redis.toml
│       └── ..
├── doc
│   └── README.md
├── hamframe.code-workspace
├── LICENSE
├── pytest.ini
├── README.md
└── requirements.txt

Contributing

This is developed on multiple different *NIX platforms (most work is done on Debian related distros). If it doesn't work on whatever it is you're using, please open a github issue with details and maybe it will get fixed. If you know how to fix it, please submit a PR. Thank you!

  • Optional: Check the open issues to see if there's anything interesting just in case.
  • Fork the repo.
  • Open the hamframe.code-workspace file in Visual Studio Code.
  • Open command palette, Python: Create Environment, follow prompts

73 Christian AK7VV