Initial import

Author: paultag

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) Paul R. Tagliamonte <[email protected]>, 2021
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

Makefile

@@ -0,0 +1,34 @@
+# {{{ Copyright (c) Paul R. Tagliamonte <[email protected]>, 2020
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE. }}}
+
+GO := $(shell which go)
+
+all: check
+
+check: lint
+
+clean:
+
+lint:
+	golint ./...
+
+.PHONY: all lint check
+
+# vim: foldmethod=marker

README.md

@@ -0,0 +1,12 @@
+# hz.tools/cli
+
+> :warning: Please read [Expectations within this Organization](https://github.com/hztools/.github/tree/main/profile#expectations-within-this-organization) before using it.
+
+[![Go Reference](https://pkg.go.dev/badge/hz.tools/cli.svg)](https://pkg.go.dev/hz.tools/cli)
+[![Go Report Card](https://goreportcard.com/badge/hz.tools/cli)](https://goreportcard.com/report/hz.tools/cli)
+
+
+This package contains a number of helpers for RF-aware CLI applications. This
+package lets you do things like Open an SDR from CLI flags, without having to
+worry about registering all the flags. This also contains the version helper,
+which will dump out diagnostic information that's handy when tracking down bugs.

flag.go

@@ -0,0 +1,59 @@
+// {{{ Copyright (c) Paul R. Tagliamonte <[email protected]>, 2020
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE. }}}
+
+package cli
+
+import (
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/spf13/pflag"
+)
+
+// Turn a flag into an environment variable.
+func createEnvName(prefix string, flag *pflag.Flag) string {
+	return fmt.Sprintf("%s%s", prefix, strings.Replace(strings.ToUpper(flag.Name), "-", "_", -1))
+}
+
+// EnvRegister will set the default values for all flags in the FlagSet to values
+// taken from the environment.
+func EnvRegister(prefix string, flagSet *pflag.FlagSet) {
+	EnvRegisterWithOverrides(prefix, flagSet, map[string]string{})
+}
+
+// EnvRegisterWithOverrides will set the default values for all flags in the
+// FlagSet to values taken from the environment.
+func EnvRegisterWithOverrides(prefix string, flagSet *pflag.FlagSet, overrides map[string]string) {
+	flagSet.VisitAll(func(flag *pflag.Flag) {
+		envName, ok := overrides[flag.Name]
+		if !ok {
+			envName = createEnvName(prefix, flag)
+		}
+		flag.Usage = fmt.Sprintf("%s (${%s})", flag.Usage, envName)
+		value := os.Getenv(envName)
+		if value == "" {
+			return
+		}
+		flag.Value.Set(value)
+	})
+}
+
+// vim: foldmethod=marker

go.mod

@@ -0,0 +1,16 @@
+module hz.tools/cli
+
+go 1.15
+
+require (
+	github.com/inconshreveable/mousetrap v1.0.1 // indirect
+	github.com/spf13/cobra v1.5.0
+	github.com/spf13/pflag v1.0.5
+	golang.org/x/net v0.0.0-20220812174116-3211cb980234 // indirect
+	golang.org/x/sys v0.1.0
+	hz.tools/fftw v0.0.8
+	hz.tools/nice v0.0.0-20221219030408-bb857d731555
+	hz.tools/rf v0.0.7
+	hz.tools/rfzeug v0.0.0-20220822174644-54f50a47c59f
+	hz.tools/sdr v0.0.0-20221219061934-cd0f8494c253
+)