AVWX
Documentation: https://engine.avwx.rest
Source Code: https://github.com/avwx-rest/avwx-engine
PyPI: https://pypi.org/project/avwx-engine/
AVWX is a global aviation weather fetching and parsing engine. It sources reports from a variety of government sources, parses individual elements, and calculates additional information like flight rules and time range interpolation.
AVWX currently supports:
- Station data and search
- METAR
- TAF
- PIREP
- AIRMET / SIGMET
- NOTAM
- NBM (NBH, NBS, NBE)
- GFS (MAV, MEX)
Install
The easiest way to get started is to download the library from pypi using pip:
python -m pip install avwx-engine
Basic Usage
Reports use ICAO, IATA, or GPS idents when specifying the desired station. Exceptions are thrown if a potentially invalid ident is given.
>>> import avwx
>>>
>>> metar = avwx.Metar('KJFK')
>>> metar.station.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.10 or above
Development
Download and install the source code and its development dependencies:
- Clone this repository
git clone https://github.com/avwx-rest/avwx-engine
cd avwx-engine
-
Requirements:
- Hatch
- Python 3.10+
-
Create a virtual environment and install the dependencies
hatch env create
- Activate the virtual environment
hatch shell
Formatting and Code Checks
hatch handles all of the formatting and linting for us. The library and test suite are fully typed and formatted. Make sure to run these checks before submitting PRs because the workflows will fail if errors are found.
Typing with mypy:
hatch run types:check
Code formatting and linting:
hatch fmt
Testing
Testing is managed by hatch which uses pytest and coverage under the hood.
hatch test
The end-to-end test files were generated using util/build_tests.py and placed into tests/{report}/data. Because Timestamp generation interprets the text based on the current date, Timestamp objects are nullified in the end-to-end tests.
Documentation
The documentation is automatically generated from the content of the docs directory and from the docstrings of the public signatures of the source code. The documentation is updated and published to engine.avwx.rest automatically as part each release.
You can also preview local changes during development:
hatch run docs:serve
Releasing
Trigger the Draft release workflow (press Run workflow). This will update the changelog & version and create a GitHub release which is in Draft state.
Find the draft release from the GitHub releases and publish it. When a release is published, it'll trigger release workflow which creates PyPI release and deploys updated documentation.
1 maintainer
Release files for avwx-engine 1.9.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| avwx_engine-1.9.9.tar.gz | 3.7 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| avwx_engine-1.9.9-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.7 MB
Release files / avwx_engine-1.9.9.tar.gz
| Download URL | avwx_engine-1.9.9.tar.gz |
|---|---|
| Size | 3.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8505b25461f4e2551b14b4dc6c1c40f54d90d96b553494a448fcc34598f41c6c
|
|
BLAKE2b-256 checksum How to use checksums |
f2a9d466bae68dd4667146a22ca27db7941c627fb43b0617bc4948b613d6f9d5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 30, 2026.
Transparency logRelease files / avwx_engine-1.9.9-py3-none-any.whl
| Download URL | avwx_engine-1.9.9-py3-none-any.whl |
|---|---|
| Size | 4.0 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ce09ba825ade7e05733d67047a53a199136f3d189aee8a09684ec6a7a222e6ff
|
|
BLAKE2b-256 checksum How to use checksums |
74499e0c2783bd9314488d8b28513b4113b4934ea1d7237942f947d39d23a655
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 30, 2026.
Transparency log
