Skip to content

andygeorge/ww

 
 

Repository files navigation

🦀 ww

ww lives in your terminal and her passion is meteorology.

If you spend time in the TUI, you'll have a little companion nearby who knows about the weather.

Contents

How to use?

Just call

ww

Without having added an address or options, ww uses the config saved as default.
If you haven't configured anything as default yet, ww can try to search for a weather station near you and save the searched location as default.

It's always possible to specify an address. E.g.,

ww melbourne

Depending on the place you are looking for, you might need to be more specific. For example, the above call will get Melbourne in Australia. If you are aiming for Melbourne in the US, ask for melbourne,florida. If the address contains spaces, separate them with a hyphen or enclose them in quotation marks (e.g., new-york or "new york").

To search explicitly for a weather station in the vicinity, call

ww auto

As a final example, we instruct ww to use Fahrenheit and mph as units and add the hourly forecast for the day

ww -u f,mph -f d

Find further usage parameters in the help information

> ww -h

Usage: ww [OPTIONS] [ADDRESS]

Arguments:
  [ADDRESS]
          Address to check the weather

Options:
  -f, --forecast <FORECAST,...>
          [e.g.: -f w,d] [possible values: disable, (w)eek, to(d)ay, (t)omorrow, mo, tu, we, th, fr, sa, su]
  -F, --historical-weather <%Y-%m-%d,...>
          [e.g.: -F 2021-12-31]
  -u, --units <UNIT,...>
          [e.g.: -u f,12h,in] [possible values: (c)elsius, (f)ahrenheit, kmh, mph, (kn)ots, ms, 12h, 24h, %, mm, (in)ch]
  -l, --language <LANGUAGE>
          Output language [e.g.: en_US]
  -s, --save
          Save the supplied values as default
  -r, --reset
          Wipe ww's configuration data
  -h, --help
          Print help
  -V, --version
          Print version

Showcase

First Run Hourly Forecast
Week Forecast *Terminal Colors

*Rendering and colors are influenced by the terminal used and its theme and font.
E.g., the first of the above screenshots show ww in nvim(toggleterm) using kitty as terminal with a Dracula theme and JetBrainsMono Nerd font. The last screenshot shows ww in Yakuake/Konsole, also with a Dracula color scheme.

Config

The address, units and default forecast can be saved as default values in ww's config file by adding the -s flag to a run. This will save the config in ww.ron.

Platform locations:
Lin: ~/.config/ww/
Mac: ~/Library/Application Support/ww/
Win: %USERPROFILE%\AppData\Roaming\ww\

Default values

(
    address: "", // Address to check the weather, e.g.: "Berlin,DE"
    language: "en_US", // Language code of the output language
    forecast: [], // Forecast to display without adding the `-f` option: `[day]` | `[week]` | `[day, week]`
    units: (
        temperature: celsius, // Temperature units: `celsius` | `fahrenheit`
        speed: kmh, // (Wind)speed units: `kmh` | `mph` | `knots` | `ms`
        time: military, // Time Format: `military` | `am_pm`
        precipitation: probability, // Precipitation units: `probability` | `mm` | `inch`
    ),
    gui: (
        border: rounded, // Border style: `rounded` | `single` | `solid` | `double`
        color: default, // Color: `default` | `plain`
        graph: (
            // Graph style: lines(solid) | lines(slim) | lines(dotted) | dotted | custom((char; 8))
            // `custom` takes exactly 8 chars. E.g. using a set of 4 chars: `custom(('⡀','⡀','⠄','⠄','⠂','⠂','⠁','⠁'))`,
            style: lines(solid),
            rowspan: double, // Graph height: `double` | `single`
            time_indicator: true, // Indication of the current time in the graph: `true` | `false`
        ),
        greeting: false, // Display greeting message: `true` | `false`
    ),
)

Installation

Use rusts package manger to install ww.

From crates.io

Version Command
release cargo install ww
development not available

From git source

Version Command
release cargo install --git https://github.com/andygeorge/ww --tag v1.1.1
development cargo install --git https://github.com/andygeorge/ww

Requirements and alternative, platform-specific installation instructions can be found in INSTALL.md.

Important To display symbols correctly, the used terminal must be configured to use a NerdFont.

Outlook

The issues section lists some of the features that are being worked on.

Contributions like 🐛bug reports, ⭐️stars and 💡suggestions are welcome alike!

A simple changelog can be found on the releases page.

Contributors

Credits

  • The app uses the open-source weather API for non-commercial use provided by Open Meteo

About

Weather companion for the terminal. Rust app.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 98.7%
  • Other 1.3%