elia/go-cmw
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity

Documentation update

Browse source
This commit is contained in:
Elia el Lazkani 2020-02-29 12:37:17 +01:00
parent 826d262d42
commit 939ec82312
2 changed files with 54 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
README.md
View file

@ -2,11 +2,6 @@
`go-cmw` is a [cmw](https://gitlab.com/elazkani/cmw) rewrite in [Go](https://golang.org/). `go-cmw` is a [cmw](https://gitlab.com/elazkani/cmw) rewrite in [Go](https://golang.org/).
# Reason
This project is a journey of learning Golang.
If you would like to make an MR, please go right ahead, it would be a good learning process for me.
# Usage # Usage
`go-cmw` features a good command-line interface thanks to `kingpin.v2`. `go-cmw` features a good command-line interface thanks to `kingpin.v2`.
@ -19,33 +14,35 @@ A small terminal wrapper around the wttr.in weather endpoint.
Flags: Flags:
--help Show context-sensitive help (also try --help-long and --help-man). --help Show context-sensitive help (also try --help-long and --help-man).
-L, --location=LOCATION Specify explicite location (--expert-mode)
-l, --language=LANGUAGE Specify explicite language (--expert-mode)
--v2 Display Data-Rich output
-m, --metric Display weather in metric -m, --metric Display weather in metric
-u, --uscs Display weather in imperial -u, --uscs Display weather in imperial
-M, --meter-second Display wind in m/s -M, --meter-second Display wind in m/s
-z, --zero Show the weather now -z, --zero Display current weather
-o, --one Show the weather for one day -o, --one Display current weather + 1 day
-w, --two Show the weather for two days -w, --two Display current weather + 2 days
-A, --ignore-user-agent Request ignoring the user agent -A, --ignore-user-agent Ignore User-Agent and force ANSI output
-F, --follow-link Follow link redirect -F, --follow-link Do not display the 'Follow' line
-n, --narrow Display weather in narrow view -n, --narrow Display narrow view (only day/night)
-q, --quiet Add the quiet flag -q, --quiet Display quiet version (no weather report)
-Q, --super-quiet Add the super quiet flag -Q, --super-quiet Display super quiet version (no weather report and no city)
-N, --no-colors Disable displaying colors (always enabled on windows -N, --no-colors Display no colors (always enabled on windows
-p, --add-frame Add a frame to the output
-T, --mid-transparency Enable mid-transparency (PNG only)
-P, --png Download a weather PNG image -P, --png Download a weather PNG image
--v2 Use the v2 endpoint -p, --add-frame Add a frame to the output (PNG only)
-t, --transparency=0 Set transparency level (0-100) (PNG only) -t, --transparency=0 Set transparency level (0-255) (PNG only) (--expert-mode)
-f, --format=FORMAT Query format (overrides everything else) -d, --download Enables download mode (--expert-mode)
-L, --location=LOCATION Specify explicite location --file-name="" Name download file (--expert-mode)
-l, --language=LANGUAGE Specify explicite language
-O, --one-liner One liner outpet (for the terminal multiplexer lovers out there) -O, --one-liner One liner outpet (for the terminal multiplexer lovers out there)
--extra-information Print extra information --format=FORMAT Specify a format query (e.g. "%l:+%c+%t") (--expert-mode)
--free-style=FREE-STYLE Specify a free-style API call (--expert-mode)
--expert-mode Print expert mode information
--version Show application version. --version Show application version.
``` ```
On top of the following command-line flags, `go-cmw` can also take advantage of environment variables. On top of the following command-line flags, `go-cmw` can also take advantage of environment variables `--expert-mode`.
`go-cmw` can take advantage of `GO_CMW_FORMAT`, `GO_CMW_LOCATION` and `GO_CMW_LANGUAGE` environment variables if set.
```console ```console
$ go-cmw --zero $ go-cmw --zero
@ -74,3 +71,19 @@ set -g status-interval 1800
WEATHER='#(go-cmw --one-liner)' WEATHER='#(go-cmw --one-liner)'
set -g status-right '... $WEATHER ...' set -g status-right '... $WEATHER ...'
``` ```
# Expert Mode
The commands labeled `--expert-mode` have special functionality attached to them.
Some of them can be used as environment variables while others override `go-cmw`
default functionality to provide the user with more flexible interface.
For more information about commands labeled `--expert-mode`
```console
$ go-cmw --expert-mode
```
# Reason
This project is a journey of learning Golang.
If you would like to make an MR, please go right ahead, it would be a good learning process for me.

18
main.go
View file

@ -89,7 +89,7 @@ func (w weather) download(resp *http.Response) {
f, err := os.Create(fName) f, err := os.Create(fName)
if err != nil { if err != nil {
log.Fatal(err) log.Fatal("Error opening file. ", err)
} }
defer f.Close() defer f.Close()
@ -163,8 +163,8 @@ func generateParamFormat() (string, bool, error) {
// Defining the command-line interface // Defining the command-line interface
var ( var (
app = kingpin.New("go-cmw", "A small terminal wrapper around the wttr.in weather endpoint.") app = kingpin.New("go-cmw", "A small terminal wrapper around the wttr.in weather endpoint.")
location = app.Flag("location", "Specify explicite location").Short('L').OverrideDefaultFromEnvar("GO_CMW_LOCATION").String() location = app.Flag("location", "Specify explicite location (--expert-mode)").Short('L').OverrideDefaultFromEnvar("GO_CMW_LOCATION").String()
language = app.Flag("language", "Specify explicite language").Short('l').OverrideDefaultFromEnvar("GO_CMW_LANGUAGE").String() language = app.Flag("language", "Specify explicite language (--expert-mode)").Short('l').OverrideDefaultFromEnvar("GO_CMW_LANGUAGE").String()
v2 = app.Flag("v2", "Display Data-Rich output").Default("false").Bool() v2 = app.Flag("v2", "Display Data-Rich output").Default("false").Bool()
switches = [13]*bool{ switches = [13]*bool{
app.Flag("metric", "Display weather in metric").Short('m').Default("false").Bool(), app.Flag("metric", "Display weather in metric").Short('m').Default("false").Bool(),
@ -182,9 +182,9 @@ var (
png = app.Flag("png", "Download a weather PNG image").Short('P').Default("false").Bool() png = app.Flag("png", "Download a weather PNG image").Short('P').Default("false").Bool()
addFrame = app.Flag("add-frame", "Add a frame to the output (PNG only)").Short('p').Default("false").Bool() addFrame = app.Flag("add-frame", "Add a frame to the output (PNG only)").Short('p').Default("false").Bool()
transparency = app.Flag("transparency", "Set transparency level (0-255) (PNG only)").OverrideDefaultFromEnvar("GO_CMW_TRANSPARENCY").Short('t').Default("0").Int() transparency = app.Flag("transparency", "Set transparency level (0-255) (PNG only) (--expert-mode)").OverrideDefaultFromEnvar("GO_CMW_TRANSPARENCY").Short('t').Default("0").Int()
download = app.Flag("download", "Enables download mode").Short('d').Default("false").Bool() download = app.Flag("download", "Enables download mode (--expert-mode)").Short('d').Default("false").Bool()
fileName = app.Flag("file-name", "Name download file").OverrideDefaultFromEnvar("GO_CMW_FILE_NAME").Default("").String() fileName = app.Flag("file-name", "Name download file (--expert-mode)").OverrideDefaultFromEnvar("GO_CMW_FILE_NAME").Default("").String()
oneLiner = app.Flag("one-liner", "One liner outpet (for the terminal multiplexer lovers out there)").Short('O').Default("false").Bool() oneLiner = app.Flag("one-liner", "One liner outpet (for the terminal multiplexer lovers out there)").Short('O').Default("false").Bool()
format = app.Flag("format", "Specify a format query (e.g. \"%l:+%c+%t\") (--expert-mode)").OverrideDefaultFromEnvar("GO_CMW_FORMAT").String() format = app.Flag("format", "Specify a format query (e.g. \"%l:+%c+%t\") (--expert-mode)").OverrideDefaultFromEnvar("GO_CMW_FORMAT").String()
freeStyle = app.Flag("free-style", "Specify a free-style API call (--expert-mode)").OverrideDefaultFromEnvar("GO_CMW_FREE_STYLE").String() freeStyle = app.Flag("free-style", "Specify a free-style API call (--expert-mode)").OverrideDefaultFromEnvar("GO_CMW_FREE_STYLE").String()
@ -260,7 +260,7 @@ Supported: af be ca da de el et fr fa hu id it
} }
// Create a function to parse all the command line parameters // Create a function to parse all the command line parameters
// provided and save them in the parameter struct. // provided.
func flagParser() { func flagParser() {
app.Version(VERSION) app.Version(VERSION)
@ -273,9 +273,9 @@ func flagParser() {
os.Exit(0) os.Exit(0)
} }
// Windows does not have color encoding // Windows terminal does not have color encoding
// so let's make sure windows users are happy // so let's make sure windows users are happy
if os.Getenv("TERM") == "" && !*png { if os.Getenv("TERM") == "" && !*png && *format != "" && *freeStyle != "" {
*switches[11] = true *switches[11] = true
} }
} }