Aviation Weather parsing engine. METAR & TAF
Switch branches/tags
Nothing to show
Clone or download

README.md

AVWX-Engine

Master

PyPI version Code Health Requirements Status Documentation Status License

Dev

Code Health Requirements Status

Aviation Weather parsing engine. METAR & TAF

Install

The easiest way to get started is to download the library from pypi using pip

pip install avwx-engine

Basic Usage

Reports use ICAO idents when specifying the desired station. Exceptions are thrown if a potentially invalid ident is given.

>>> import avwx
>>> 
>>> metar = avwx.Metar('KJFK')
>>> metar.station_info.name
'John F Kennedy International Airport'
>>> metar.update()
True
>>> metar.data.flight_rules
'IFR'

You can learn more by reading the project documentation

Note: This library requires Python 3.6 or above

Develop

Download and install the source code and its dependencies:

git clone github.com/flyinactor91/AVWX-Engine
cd AVWX-Engine
pip install -U .

No other packages are necessary.

Test

While there's no requirement to use a specific testing library, the test suite was built while using the pytest library.

pip install pytest

To run the tests, run pytest from the project root. The tests should pick up the local version of avwx so a pip install is not necessary every time.

pytest

The end-to-end test files were generated using utils/testMaker.py and placed into tests/metar and tests/taf respectively. Because Timestamp generation interprets the text based on the current date, Timestamp objects are nullified in the end-to-end tests.

Docs

AVWX uses Sphinx to build its documentation. It's just another install:

pip install sphinx

To build the docs:

cd docs
make html