MetarNavigate/README.md

43 lines
1.1 KiB
Markdown

# 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:
```bash
pip install -e .
```
this will install the application and the dependencies
after that you'll need to configure the application by issuing:
```bash
metarNavigate --no-tui -c
```
or
```bash
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:
```bash
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:
```bash
metarNavigate --no-tui --detailed <ICAO>
```
or
```bash
metarNavigate --no-tui -d <ICAO>
```
this will print all details of the METAR Message with an explanation of each part of the message.
[!WARNING]
The flags ``` -d ``` or the flag ```--detailed ``` can you be used with the flag ```--no-tui ```