Website URL:
   Skip to content
   
   Sign up  (BUTTON)
   (BUTTON)
     * Why GitHub?
       Features →
          + Code review
          + Project management
          + Integrations
          + Actions
          + Packages
          + Security
          + Team management
          + Hosting
          + Customer stories →
          + Security →
     * Team
     * Enterprise
     * Explore
          + Explore GitHub →

Learn & contribute
          + Topics
          + Collections
          + Trending
          + Learning Lab
          + Open source guides

Connect with others
          + Events
          + Community forum
          + GitHub Education
     * Marketplace
     * Pricing
       Plans →
          + Compare plans
          + Contact Sales
          + Nonprofit →
          + Education →

   Sign in  Sign up 

   (BUTTON)

chubin / wttr.in

     * Watch  199 
     * Star  12.3k 
     * Fork  628 

   ⛅ The right way to check the weather
   wttr.in
   Apache-2.0 License 
   12.3k stars  628 forks 
   Star 
   Watch 
     * Code 
     * Issues 125 
     * Pull requests 2 
     * Actions 
     * Projects 1 
     * Security 
     * Insights 

   More
     * Code 
     * Issues 
     * Pull requests 
     * Actions 
     * Projects 
     * Security 
     * Insights 

   (BUTTON) Dismiss

Join GitHub today

   GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
   Sign up
   Branch: master
   Go to file  Code

Clone with HTTPS 

   Use Git or checkout with SVN using the web URL.
   https://github.com/c
     * Open with GitHub Desktop 
     * Download ZIP 

Launching GitHub Desktop

   If nothing happens, download GitHub Desktop and try again.
   (BUTTON) Go back

Launching GitHub Desktop

   If nothing happens, download GitHub Desktop and try again.
   (BUTTON) Go back

Launching Xcode

   If nothing happens, download Xcode and try again.
   (BUTTON) Go back

Launching Visual Studio

   If nothing happens, download the GitHub extension for Visual Studio and try again.
   (BUTTON) Go back

Latest commit

   @chubin 
   chubin committed 762513e Jul 14, 2020
   Added Aakash to the list of contributors (#429)

Git stats

     * 873 commits 
     * 2 branches 
     * 0 tags 

Files

   Permalink
   Failed to load latest commit information.
   Type
   Name
   Latest commit message
   Commit time
   bin
   proxy: increased expiration time
   Jun 1, 2020
   cmd
   dont cache cyclic requests (#460)
   Jun 8, 2020
   lib
   Merge pull request #495 from skyme5/translation-hi
   Jul 14, 2020
   share
   Added Aakash to the list of contributors (#429)
   Jul 14, 2020
   test
   added tests for astrodata
   May 10, 2020
   .gitignore
   dockerized project
   Feb 17, 2020
   .travis.yml
   travis: pyflake only bin and lib
   Dec 29, 2019
   Dockerfile
   minor fixes of Dockerfile and related things
   Feb 17, 2020
   LICENSE
   Initial commit
   Dec 26, 2015
   README.md
   single line: now newline for %-notation by default (#496)
   Jul 9, 2020
   requirements.txt
   requirements.txt: fixed dependency name
   Apr 4, 2020
   (BUTTON) View code

README.md

   wttr.in — the right way to check the weather!

   wttr.in is a console-oriented weather forecast service that supports various information representation methods like terminal-oriented ANSI-sequences for console HTTP clients (curl, httpie, or wget), HTML for web browsers, or PNG for graphical viewers.

   wttr.in uses wego for visualization and various data sources for weather forecast information.

   You can see it running here: wttr.in.

Usage

   You can access the service from a shell or from a Web browser like this:
$ curl wttr.in
Weather for City: Paris, France

     \   /     Clear
      .-.      10 – 11 °C
   ― (   ) ―   ↑ 11 km/h
      `-’      10 km
     /   \     0.0 mm

   Here is an actual weather report for your location (it's live!):

   Weather Report 

   (It's not your actual location - GitHub's CDN hides your real IP address with its own IP address, but it's still a live weather report in your language.)

   Or in PowerShell:
Invoke-RestMethod http://wttr.in

   Want to get the weather information for a specific location? You can add the desired location to the URL in your request like this:
$ curl wttr.in/London
$ curl wttr.in/Moscow
$ curl wttr.in/Salt+Lake+City

   If you omit the location name, you will get the report for your current location based on your IP address.

   Use 3-letter airport codes in order to get the weather information at a certain airport:
$ curl wttr.in/muc      # Weather for IATA: muc, Munich International Airport, Germany
$ curl wttr.in/ham      # Weather for IATA: ham, Hamburg Airport, Germany

   Let's say you'd like to get the weather for a geographical location other than a town or city - maybe an attraction in a city, a mountain name, or some special location. Add the character ~ before the name to look up that special location name before the weather is then retrieved:
$ curl wttr.in/~Vostok+Station
$ curl wttr.in/~Eiffel+Tower
$ curl wttr.in/~Kilimanjaro

   For these examples, you'll see a line below the weather forecast output that shows the geolocation results of looking up the location:
Location: Vostok Station, станция Восток, AAT, Antarctica [-78.4642714,106.8364678]
Location: Tour Eiffel, 5, Avenue Anatole France, Gros-Caillou, 7e, Paris, Île-de-France, 75007, France [48.8582602,2.29449905432]
Location: Kilimanjaro, Northern, Tanzania [-3.4762789,37.3872648]

   You can also use IP-addresses (direct) or domain names (prefixed with @) to specify a location:
$ curl wttr.in/@github.com
$ curl wttr.in/@msu.ru

   To get detailed information online, you can access the /:help page:
$ curl wttr.in/:help

Weather Units

   By default the USCS units are used for the queries from the USA and the metric system for the rest of the world. You can override this behavior by adding ?u or ?m to a URL like this:
$ curl wttr.in/Amsterdam?u
$ curl wttr.in/Amsterdam?m

Supported output formats and views

   wttr.in currently supports five output formats:
     * ANSI for the terminal;
     * Plain-text for the terminal and scripts;
     * HTML for the browser;
     * PNG for the graphical viewers;
     * JSON for scripts and APIs;
     * Prometheus metrics for scripts and APIs.

   The ANSI and HTML formats are selected basing on the User-Agent string. The PNG format can be forced by adding .png to the end of the query:
$ wget wttr.in/Paris.png

   You can use all of the options with the PNG-format like in an URL, but you have to separate them with _ instead of ? and &:
$ wget wttr.in/Paris_0tqp_lang=fr.png

   Useful options for the PNG format:
     * t for transparency (transparency=150);
     * transparency=0..255 for a custom transparency level.

   Transparency is a useful feature when weather PNGs are used to add weather data to pictures:
$ convert source.jpg <( curl wttr.in/Oymyakon_tqp0.png ) -geometry +50+50 -composite target.jpg

   In this example:
     * source.jpg - source file;
     * target.jpg - target file;
     * Oymyakon - name of the location;
     * tqp0 - options (recommended).

   Picture with weather data 

   You can embed a special wttr.in widget, that displays the weather condition for the current or a selected location, into a HTML page using the wttr-switcher. That is how it looks like: wttr-switcher-example or on a real world web site: https://feuerwehr-eisolzried.de/.

   Embedded wttr.in example at feuerwehr-eisolzried.de 

One-line output

   For one-line output format, specify additional URL parameter format:
$ curl wttr.in/Nuremberg?format=3
Nuremberg: 🌦 +11⁰C

   Available preconfigured formats: 1, 2, 3, 4 and the custom format using the percent notation (see below).

   You can specify multiple locations separated with : (for repeating queries):
$ curl wttr.in/Nuremberg:Hamburg:Berlin?format=3
Nuremberg: 🌦 +11⁰C

   Or to process all this queries at once:
$ curl -s 'wttr.in/{Nuremberg,Hamburg,Berlin}?format=3'
Nuremberg: 🌦 +11⁰C
Hamburg: 🌦 +8⁰C
Berlin: 🌦 +8⁰C

   To specify your own custom output format, use the special %-notation:
    c    Weather condition,
    C    Weather condition textual name,
    h    Humidity,
    t    Temperature (Actual),
    f    Temperature (Feels Like),
    w    Wind,
    l    Location,
    m    Moonphase 🌑🌒🌓🌔🌕🌖🌗🌘,
    M    Moonday,
    p    precipitation (mm),
    o    Probability of Precipitation,
    P    pressure (hPa),

    D    Dawn*,
    S    Sunrise*,
    z    Zenith*,
    s    Sunset*,
    d    Dusk*.

(*times are shown in the local timezone)

   So, these two calls are the same:
    $ curl wttr.in/London?format=3
    London: ⛅️ +7⁰C
    $ curl wttr.in/London?format="%l:+%c+%t\n"
    London: ⛅️ +7⁰C

   Keep in mind, that when using in tmux.conf, you have to escape % with %, i.e. write there %% instead of %.

   In programs, that are querying the service automatically (such as tmux), it is better to use some reasonable update interval. In tmux, you can configure it with status-interval.

   If several, : separated locations, are specified in the query, specify update period as an additional query parameter period=:
set -g status-interval 60
WEATHER='#(curl -s wttr.in/London:Stockholm:Moscow\?format\="%%l:+%%c%%20%%t%%60%%w&period=60")'
set -g status-right "$WEATHER ..."

   wttr.in in tmux status bar 

   To see emojis in terminal, you need:
    1. Terminal support for emojis (was added to Cairo 1.15.8);
    2. Font with emojis support.

   For the Emoji font, we recommend Noto Color Emoji, and a good alternative option would be the Emoji One font; both of them support all necessary emoji glyphs.

   Font configuration:
$ cat ~/.config/fontconfig/fonts.conf



  
    serif
    
      Noto Color Emoji
    
  
  
    sans-serif
    
      Noto Color Emoji
    
  
  
    monospace
    
      Noto Color Emoji
    
  


   (to apply the configuration, run fc-cache -f -v)

Data-rich output format

   In the experimental data-rich output format, that is available under the view code v2, a lot of additional weather and astronomical information is available:
     * Temperature, and precepetation changes forecast throughout the days;
     * Moonphase for today and the next three days;
     * The current weather condition, temperature, humidity, windspeed and direction, pressure;
     * Timezone;
     * Dawn, sunrise, noon, sunset, dusk time for he selected location;
     * Precise geographical coordinates for the selected location.

  $ curl v2.wttr.in/München

   or
  $ curl wttr.in/München?format=v2

   or, if you prefer Nerd Fonts instead of Emoji, v2d (day) or v2n (night):
  $ curl v2d.wttr.in/München

   data-reach output format 

   (The mode is experimental, and it has several limitations currently:
     * It works only in terminal;
     * Only English is supported).

   Currently, you need some tweaks for some terminals, to get the best possible visualization.

URXVT

   Depending on your configuration you might be taking all steps, or only a few. URXVT currently doesn't support emoji related fonts, but we can get almost the same effect using Font-Symbola. So add to your .Xresources file the following line:
    xft:symbola:size=10:minspace=False

   You can add it after your preferred font and it will only show up when required. Then, if you see or feel like you're having spacing issues, add this: URxvt.letterSpace: 0 For some reason URXVT sometimes stops deciding right the word spacing and we need to force it this way.

   The result, should look like:

   URXVT Emoji line 

Different output formats

JSON output

   The JSON format is a feature providing access to wttr.in data through an easy-to-parse format, without requiring the user to create a complex script to reinterpret wttr.in's graphical output.

   To fetch information in JSON format, use the following syntax:
$ curl wttr.in/Detroit?format=j1

   This will fetch information on the Detroit region in JSON format. The j1 format code is used to allow for the use of other layouts for the JSON output.

   The result will look something like the following:
{
        "current_condition": [
                {
                    "FeelsLikeC": "25",
                    "FeelsLikeF": "76",
                    "cloudcover": "100",
                    "humidity": "76",
                    "observation_time": "04:08 PM",
                    "precipMM": "0.2",
                    "pressure": "1019",
                    "temp_C": "22",
                    "temp_F": "72",
                    "uvIndex": 5,
                    "visibility": "16",
                    "weatherCode": "122",
                    "weatherDesc": [
                        {
                            "value": "Overcast"
                        }
                    ],
                    "weatherIconUrl": [
                        {
                            "value": ""
                        }
                    ],
                    "winddir16Point": "NNE",
                    "winddirDegree": "20",
                    "windspeedKmph": "7",
                    "windspeedMiles": "4"
                }
        ],
...

   Most of these values are self-explanatory, aside from weatherCode. The weatherCode is an enumeration which you can find at either the WorldWeatherOnline website or in the wttr.in source code.

Prometheus Metrics Output

   The Prometheus Metrics format is a feature providing access to wttr.in data through an easy-to-parse format for monitoring systems, without requiring the user to create a complex script to reinterpret wttr.in's graphical output.

   To fetch information in Prometheus format, use the following syntax:
$ curl wttr.in/Detroit?format=p1

   This will fetch information on the Detroit region in Prometheus Metrics format. The p1 format code is used to allow for the use of other layouts for the Prometheus Metrics output.

   A possible configuration for Prometheus could look like this:
    - job_name: 'wttr_in_detroit'
        static_configs:
            - targets: ['wttr.in']
        metrics_path: '/Detroit'
        params:
            format: ['p1']

   The result will look something like the following:
# HELP temperature_feels_like_celsius Feels Like Temperature in Celsius
temperature_feels_like_celsius{forecast="current"} 7
# HELP temperature_feels_like_fahrenheit Feels Like Temperature in Fahrenheit
temperature_feels_like_fahrenheit{forecast="current"} 45
[truncated]

   ...

Moon phases

   wttr.in can also be used to check the phase of the Moon. This example shows how to see the current Moon phase in the full-output mode:
$ curl wttr.in/Moon

   Get the Moon phase for a particular date by adding @YYYY-MM-DD:
$ curl wttr.in/Moon@2016-12-25

   The Moon phase information uses pyphoon as its backend.

   To get the moon phase information in the online mode, use %m:
$ curl wttr.in/London?format=%m
🌖

   Keep in mid that the Unicode representation of moonphases suffers 2 caveats:
     * With some fonts, the representation 🌘 is ambiguous, for it either seem almost-shadowed or almost-lit, depending on whether your terminal is in light mode or dark mode. Relying on colored fonts like noto-fonts works around this problem.
     * The representation 🌘 is also ambiguous, for it means "last quarter" in northern hemisphere, but "first quarter" in souther hemisphere. It also means nothing in tropical zones. This is a limitation that Unicode is aware about. But it has not been worked around at wttr.in yet.

   See #247, #364 for the corresponding tracking issues, and pyphoon#1 for pyphoon. Any help is welcome.

Internationalization and localization

   wttr.in supports multilingual locations names that can be specified in any language in the world (it may be surprising, but many locations in the world don't have an English name).

   The query string should be specified in Unicode (hex-encoded or not). Spaces in the query string must be replaced with +:
$ curl wttr.in/станция+Восток
Weather report: станция Восток

               Overcast
      .--.     -65 – -47 °C
   .-(    ).   ↑ 23 km/h
  (___.__)__)  15 km
               0.0 mm

   The language used for the output (except the location name) does not depend on the input language and it is either English (by default) or the preferred language of the browser (if the query was issued from a browser) that is specified in the query headers (Accept-Language).

   The language can be set explicitly when using console clients by using command-line options like this:
curl -H "Accept-Language: fr" wttr.in
http GET wttr.in Accept-Language:ru

   The preferred language can be forced using the lang option:
$ curl wttr.in/Berlin?lang=de

   The third option is to choose the language using the DNS name used in the query:
$ curl de.wttr.in/Berlin

   wttr.in is currently translated into 54 languages, and the number of supported languages is constantly growing.

   See /:translation to learn more about the translation process, to see the list of supported languages and contributors, or to know how you can help to translate wttr.in in your language.

   Queries to wttr.in in various languages 

Windows Users

   There are currently two Windows related issues that prevent the examples found on this page from working exactly as expected out of the box. Until Microsoft fixes the issues, there are a few workarounds. To circumvent both issues you may use a shell such as bash on the Windows Subsystem for Linux (WSL) or read on for alternative solutions.

Garbage characters in the output

   There is a limitation of the current Win32 version of curl. Until the Win32 curl issue is resolved and rolled out in a future Windows release, it is recommended that you use Powershell’s Invoke-Web-Request command instead:
     * (Invoke-WebRequest http://wttr.in).Content

Missing or double wide diagonal wind direction characters

   The second issue is regarding the width of the diagonal arrow glyphs that some Windows Terminal Applications such as the default conhost.exe use. At the time of writing this, ConEmu.exe, ConEmu64.exe and Terminal Applications built on top of ConEmu such as Cmder (cmder.exe) use these double-wide glyphs by default. The result is the same with all of these programs, either a missing character for certain wind directions or a broken table in the output or both. Some third-party Terminal Applications have addressed the wind direction glyph issue but that fix depends on the font and the Terminal Application you are using. One way to display the diagonal wind direction glyphs in your Terminal Application is to use Windows Terminal which is currently available in the
   Microsoft Store. Windows Terminal is currently a preview release and will be rolled out as the default Terminal Application in an upcoming release. If your output is still skewed after using Windows Terminal then try maximizing the terminal window. Another way you can display the diagonal wind direction is to swap out the problematic characters with forward and backward slashes as shown here.

Installation

   To install the application:
    1. Install external dependencies
    2. Install Python dependencies used by the service
    3. Configure IP2Location (optional)
    4. Get a WorldWeatherOnline API and configure wego
    5. Configure wttr.in
    6. Configure the HTTP-frontend service

Install external dependencies

   wttr.in has the following external dependencies:
     * golang, wego dependency
     * wego, weather client for terminal

   After you install golang, install wego:
$ go get -u github.com/schachmat/wego
$ go install github.com/schachmat/wego

Install Python dependencies

   Python requirements:
     * Flask
     * geoip2
     * geopy
     * requests
     * gevent

   If you want to get weather reports as PNG files, you'll also need to install:
     * PIL
     * pyte (>=0.6)
     * necessary fonts

   You can install most of them using pip.

   Some python package use LLVM, so install it first:
$ apt-get install llvm-7 llvm-7-dev

   If virtualenv is used:
$ virtualenv -p python3 ve
$ ve/bin/pip3 install -r requirements.txt
$ ve/bin/python3 bin/srv.py

   Also, you need to install the geoip2 database. You can use a free database GeoLite2 that can be downloaded from (http://dev.maxmind.com/geoip/geoip2/geolite2/).

Configure IP2Location (optional)

   If you want to use the IP2location service for IP-addresses that are not covered by GeoLite2, you have to obtain a API key of that service, and after that save into the ~/.ip2location.key file:
$ echo 'YOUR_IP2LOCATION_KEY' > ~/.ip2location.key

   If you don't have this file, the service will be silently skipped (it is not a big problem, because the MaxMind database is pretty good).

Get a WorldWeatherOnline key and configure wego

   To get a WorldWeatherOnline API key, you must register here:
https://developer.worldweatheronline.com/auth/register

   After you have a WorldWeatherOnline key, you can save it into the WWO key file: ~/.wwo.key

   Also, you have to specify the key in the wego configuration:
$ cat ~/.wegorc
{
        "APIKey": "00XXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "City": "London",
        "Numdays": 3,
        "Imperial": false,
        "Lang": "en"
}

   The City parameter in ~/.wegorc is ignored.

Configure wttr.in

   Configure the following environment variables that define the path to the local wttr.in installation, to the GeoLite database, and to the wego installation. For example:
export WTTR_MYDIR="/home/igor/wttr.in"
export WTTR_GEOLITE="/home/igor/wttr.in/GeoLite2-City.mmdb"
export WTTR_WEGO="/home/igor/go/bin/wego"
export WTTR_LISTEN_HOST="0.0.0.0"
export WTTR_LISTEN_PORT="8002"

Configure the HTTP-frontend service

   It's recommended that you also configure the web server that will be used to access the service:
server {
        listen [::]:80;
        server_name  wttr.in *.wttr.in;
        access_log  /var/log/nginx/wttr.in-access.log  main;
        error_log  /var/log/nginx/wttr.in-error.log;

        location / {
            proxy_pass         http://127.0.0.1:8002;

            proxy_set_header   Host             $host;
            proxy_set_header   X-Real-IP        $remote_addr;
            proxy_set_header   X-Forwarded-For  $remote_addr;

            client_max_body_size       10m;
            client_body_buffer_size    128k;

            proxy_connect_timeout      90;
            proxy_send_timeout         90;
            proxy_read_timeout         90;

            proxy_buffer_size          4k;
            proxy_buffers              4 32k;
            proxy_busy_buffers_size    64k;
            proxy_temp_file_write_size 64k;

            expires                    off;
        }
}

About

   ⛅ The right way to check the weather
   wttr.in

Topics

   weather-information  weather-api  curl  weather  weather-app  terminal  ascii-art 

Resources

   Readme 

License

   Apache-2.0 License 

Releases 

   No releases published

Contributors 103 

     * @chubin 
     * @Petewg 
     * @pavse 
     * @janesmae 
     * @iago-lito 
     * @mrFrosty 
     * @fbitti 
     * @MAGICCC 
     * @mpetruska 
     * @fredrikfjeld 
     * @javad94 

   + 92 contributors 

Languages

     * Python 74.5% 
     * Go 16.5% 
     * Shell 6.6% 
     * SaltStack 0.9% 
     * HTML 0.8% 
     * Dockerfile 0.5% 
     * CSS 0.2% 

     * © 2020 GitHub, Inc.
     * Terms
     * Privacy
     * Security
     * Status
     * Help

   
     * Contact GitHub
     * Pricing
     * API
     * Training
     * Blog
     * About

   (BUTTON) You can’t perform that action at this time.

   You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.

   (BUTTON)