GHMiranda
/
MetarNavigate
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
5 Commits 2 Branches 0 Tags 64 KiB
Python 100%
Go to file
Gustavo Henrique Santos Souza de Miranda 441c2beda0 Add usage instructions and configuration details to README.md 2025-10-30 17:25:11 -03:00
src Rename project files and entry point to follow consistent naming conventions. 2025-10-29 00:18:58 -03:00
.gitignore Update .gitignore to exclude IDE configuration files 2025-10-29 00:29:29 -03:00
LICENSE Initial Commit 2025-10-29 00:05:17 -03:00
README.md Add usage instructions and configuration details to README.md 2025-10-30 17:25:11 -03:00
pyproject.toml Rename project files and entry point to follow consistent naming conventions. 2025-10-29 00:18:58 -03:00

README.md

METAR NAVIGATE

A Simple METAR Application that feeds from CheckWX API

It has two modes of display, a simple CLI using Rich and a TUI using Textual

Usage

First, you need to install the application by issuing:

pip install -e .

this will install the application and the dependencies after that you'll need to configure the application by issuing:

metarNavigate --no-tui -c

or

metarNavigate --no-tui --configure

you'll need a checkWX API key to use the application which is free

after the configuration process you can use the application by issuing:

metarNavigate --no-tui <ICAO>

this will run the application in CLI mode and display the METAR for the ICAO code issued as argument.

If you wish to see a detailed breakdown of the METAR in CLI mode, you can issue:

metarNavigate --no-tui --detailed <ICAO>

or

metarNavigate --no-tui -d <ICAO>

this will print all details of the METAR Message with an explanation of each part of the message.