# AVWX: Aviation Weather for Humans
[![PyPI version](https://badge.fury.io/py/avwx-engine.svg)](https://badge.fury.io/py/avwx-engine)
[![Requirements Status](https://requires.io/github/avwx-rest/avwx-engine/requirements.svg?branch=master)](https://requires.io/github/avwx-rest/avwx-engine/requirements/?branch=master)
[![Documentation Status](https://readthedocs.org/projects/avwx-engine/badge/?version=latest)](http://avwx-engine.readthedocs.io/en/latest/?badge=latest)
[![License](https://img.shields.io/pypi/l/avwx-engine.svg)](https://pypi.org/project/avwx-engine/)
<!-- [![Code Health](https://landscape.io/github/avwx-rest/AVWX-Engine/master/landscape.svg?style=flat)](https://landscape.io/github/avwx-rest/AVWX-Engine/master) -->
![AVWX logo](https://avwx.rest/static/favicons/apple-icon-76x76.png)
## Install
The easiest way to get started is to download the library from pypi using pip
```bash
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.
```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://avwx-engine.readthedocs.io/en/latest/)
**Note**: This library requires Python 3.6 or above
## Develop
Download and install the source code and its development dependencies:
```bash
git clone github.com/avwx-rest/AVWX-Engine
cd AVWX-Engine
pip install -Ur requirements.txt
```
Code formatting should be handled by hooks in pre-commit. Before committing any code, be should to install pre-commit into the local git project:
```bash
pre-commit install
```
## Test
The easiest way to test the package is using the `nox` library, which is installed as a dev dependencies. It will manage all tests, sessions, supported versions (when available), and cleanup. The tests will pick up the local version of `avwx`.
```bash
nox
```
If you want to run the tests directly, the test suite was built while using the `pytest` library, which is also installed as a dev dependency.
```bash
pytest
```
The end-to-end test files were generated using `util/build_tests.py` and placed into `tests/{report}`. Because Timestamp generation interprets the text based on the current date, Timestamp objects are nullified in the end-to-end tests.
## Docs
AVWX uses `mkdocs` to build its documentation. It's just another install:
```bash
pip install mkdocs
```
To serve the docs during development:
```bash
cd docs
mkdocs serve
```
没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论
收起资源包目录
avwx-engine-1.4.0a9.tar.gz (42个子文件)
avwx-engine-1.4.0a9
PKG-INFO 603B
avwx_engine.egg-info
PKG-INFO 603B
requires.txt 195B
SOURCES.txt 924B
top_level.txt 5B
dependency_links.txt 1B
LICENSE 1KB
setup.cfg 38B
setup.py 1KB
avwx
structs.py 6KB
data
stations.json 15.86MB
aircraft.json 10KB
forecast
gfs.py 7KB
__init__.py 0B
base.py 312B
station.py 7KB
static
core.py 5KB
gfs.py 2KB
__init__.py 0B
taf.py 2KB
metar.py 352B
service.py 12KB
__init__.py 218B
parsing
summary.py 2KB
core.py 25KB
remarks.py 4KB
__init__.py 0B
speech.py 7KB
translate
gfs.py 1011B
__init__.py 0B
taf.py 4KB
base.py 6KB
metar.py 791B
base.py 3KB
current
airep.py 844B
__init__.py 0B
taf.py 15KB
pirep.py 6KB
base.py 4KB
metar.py 9KB
exceptions.py 310B
README.md 3KB
共 42 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功