# AVWX
[](https://pypi.python.org/pypi/avwx-engine/)
[](https://pypi.python.org/pypi/avwx-engine/)
[](https://pypi.python.org/pypi/avwx-engine/)
[]()
---
**Documentation**: [https://engine.avwx.rest](https://engine.avwx.rest)
**Source Code**: [https://github.com/avwx-rest/avwx-engine](https://github.com/avwx-rest/avwx-engine)
**PyPI**: [https://pypi.org/project/avwx-engine/](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:
```bash
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.
```python
>>> 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](https://engine.avwx.rest)
**Note**: This library requires Python 3.8 or above
## Development
Download and install the source code and its development dependencies:
* Clone this repository
```sh
git clone https://github.com/avwx-rest/avwx-engine
cd avwx-engine
```
* Requirements:
* [Poetry](https://python-poetry.org/)
* Python 3.8+
* Create a virtual environment and install the dependencies
```sh
poetry install
```
* Activate the virtual environment
```sh
poetry shell
```
### Testing
The test suite was built while using the `pytest` library, which is also installed as a dev dependency. The project uses `poethepoet` (dev dependency) to run basic tasks.
```bash
poe 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](./docs) and from the docstrings of the public signatures of the source code. The documentation is updated and published to [engine.avwx.rest](https://engine.avwx.rest) automatically as part each release.
You can also preview local changes during development:
```sh
poe docs
```
### Releasing
Trigger the [Draft release workflow](https://github.com/avwx-rest/avwx-engine/actions/workflows/draft_release.yml) (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](https://github.com/avwx-rest/avwx-engine/releases) and publish it. When a release is published, it'll trigger [release](https://github.com/avwx-rest/avwx-engine/blob/main/.github/workflows/release.yml) workflow which creates PyPI
release and deploys updated documentation.
### Pre-commit
Pre-commit hooks run all the auto-formatters, linters, and other quality checks to make sure the changeset is in good shape before a commit/push happens.
You can install the hooks with (runs for each commit):
```sh
pre-commit install
```
Or if you want them to run only for each push:
```sh
pre-commit install -t pre-push
```
Or if you want e.g. want to run all checks manually for all files:
```sh
pre-commit run --all-files
```
Raw data
{
"_id": null,
"home_page": "https://engine.avwx.rest",
"name": "avwx-engine",
"maintainer": "",
"docs_url": "https://pythonhosted.org/avwx-engine/",
"requires_python": ">=3.8,<3.12",
"maintainer_email": "",
"keywords": "aviation,weather,metar",
"author": "Michael duPont",
"author_email": "michael@dupont.dev",
"download_url": "https://files.pythonhosted.org/packages/0f/e4/16030f881abcd22618c08b9771ff314ad4b19b91d06988430ff557e4882b/avwx_engine-1.8.27.tar.gz",
"platform": null,
"description": "# AVWX\n\n\n\n[](https://pypi.python.org/pypi/avwx-engine/)\n[](https://pypi.python.org/pypi/avwx-engine/)\n[](https://pypi.python.org/pypi/avwx-engine/)\n[]()\n\n---\n\n**Documentation**: [https://engine.avwx.rest](https://engine.avwx.rest)\n\n**Source Code**: [https://github.com/avwx-rest/avwx-engine](https://github.com/avwx-rest/avwx-engine)\n\n**PyPI**: [https://pypi.org/project/avwx-engine/](https://pypi.org/project/avwx-engine/)\n\n---\n\nAVWX 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.\n\nAVWX currently supports:\n\n- Station data and search\n- METAR\n- TAF\n- PIREP\n- AIRMET / SIGMET\n- NOTAM\n- NBM (NBH, NBS, NBE)\n- GFS (MAV, MEX)\n\n## Install\n\nThe easiest way to get started is to download the library from pypi using pip:\n\n```bash\npython -m pip install avwx-engine\n```\n\n## Basic Usage\n\nReports use ICAO, IATA, or GPS idents when specifying the desired station. Exceptions are thrown if a potentially invalid ident is given.\n\n```python\n>>> import avwx\n>>>\n>>> metar = avwx.Metar('KJFK')\n>>> metar.station.name\n'John F Kennedy International Airport'\n>>> metar.update()\nTrue\n>>> metar.data.flight_rules\n'IFR'\n```\n\nYou can learn more by reading the [project documentation](https://engine.avwx.rest)\n\n**Note**: This library requires Python 3.8 or above\n\n## Development\n\nDownload and install the source code and its development dependencies:\n\n* Clone this repository\n\n```sh\ngit clone https://github.com/avwx-rest/avwx-engine\ncd avwx-engine\n```\n\n* Requirements:\n * [Poetry](https://python-poetry.org/)\n * Python 3.8+\n* Create a virtual environment and install the dependencies\n\n```sh\npoetry install\n```\n\n* Activate the virtual environment\n\n```sh\npoetry shell\n```\n\n### Testing\n\nThe test suite was built while using the `pytest` library, which is also installed as a dev dependency. The project uses `poethepoet` (dev dependency) to run basic tasks.\n\n```bash\npoe test\n```\n\nThe 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.\n\n### Documentation\n\nThe documentation is automatically generated from the content of the [docs directory](./docs) and from the docstrings of the public signatures of the source code. The documentation is updated and published to [engine.avwx.rest](https://engine.avwx.rest) automatically as part each release.\n\n You can also preview local changes during development:\n\n```sh\npoe docs\n```\n\n### Releasing\n\nTrigger the [Draft release workflow](https://github.com/avwx-rest/avwx-engine/actions/workflows/draft_release.yml) (press _Run workflow_). This will update the changelog & version and create a GitHub release which is in _Draft_ state.\n\nFind the draft release from the\n[GitHub releases](https://github.com/avwx-rest/avwx-engine/releases) and publish it. When a release is published, it'll trigger [release](https://github.com/avwx-rest/avwx-engine/blob/main/.github/workflows/release.yml) workflow which creates PyPI\n release and deploys updated documentation.\n\n### Pre-commit\n\nPre-commit hooks run all the auto-formatters, linters, and other quality checks to make sure the changeset is in good shape before a commit/push happens.\n\nYou can install the hooks with (runs for each commit):\n\n```sh\npre-commit install\n```\n\nOr if you want them to run only for each push:\n\n```sh\npre-commit install -t pre-push\n```\n\nOr if you want e.g. want to run all checks manually for all files:\n\n```sh\npre-commit run --all-files\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Aviation weather report parsing library",
"version": "1.8.27",
"project_urls": {
"Documentation": "https://engine.avwx.rest",
"Homepage": "https://engine.avwx.rest",
"Repository": "https://github.com/avwx-rest/avwx-engine"
},
"split_keywords": [
"aviation",
"weather",
"metar"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c87dd8d190627e37c9b43bfafb798c1c94622796965e13a5b2186245d39a0496",
"md5": "db5a864477a1c327b906410567bd5d47",
"sha256": "fc1912b5787a22776b433d8812b5ff2988d09b14ccf0e7e39efd98891665397d"
},
"downloads": -1,
"filename": "avwx_engine-1.8.27-py3-none-any.whl",
"has_sig": false,
"md5_digest": "db5a864477a1c327b906410567bd5d47",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 3357499,
"upload_time": "2024-01-01T06:25:40",
"upload_time_iso_8601": "2024-01-01T06:25:40.880068Z",
"url": "https://files.pythonhosted.org/packages/c8/7d/d8d190627e37c9b43bfafb798c1c94622796965e13a5b2186245d39a0496/avwx_engine-1.8.27-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0fe416030f881abcd22618c08b9771ff314ad4b19b91d06988430ff557e4882b",
"md5": "f2820630825670698f6165562d575085",
"sha256": "df2c4040fcd70c1323913fde560468519315a2b542cef04ec39f5ff60feba6b5"
},
"downloads": -1,
"filename": "avwx_engine-1.8.27.tar.gz",
"has_sig": false,
"md5_digest": "f2820630825670698f6165562d575085",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 3164245,
"upload_time": "2024-01-01T06:25:44",
"upload_time_iso_8601": "2024-01-01T06:25:44.119196Z",
"url": "https://files.pythonhosted.org/packages/0f/e4/16030f881abcd22618c08b9771ff314ad4b19b91d06988430ff557e4882b/avwx_engine-1.8.27.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-01 06:25:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "avwx-rest",
"github_project": "avwx-engine",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "avwx-engine"
}
JSON
