awc_client


Nameawc_client JSON
Version 1.0.1 PyPI version JSON
download
home_pagehttps://github.com/GIT_USER_ID/GIT_REPO_ID
SummaryAviationWeather.gov API
upload_time2024-10-25 15:09:48
maintainerNone
docs_urlNone
authorOpenAPI Generator Community
requires_python<4.0,>=3.8
licenseNoLicense
keywords openapi openapi-generator aviationweather.gov api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # awc-client
New data API of AviationWeather.gov. This supercedes the ADDS Data Server and AviationWeather Web Services.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 3.12
- Package version: 1.0.0
- Generator version: 7.10.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.7+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import awc_client
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import awc_client
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import awc_client
from awc_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = awc_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with awc_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = awc_client.DataApi(api_client)
    ids = 'KMCI' # str | Station ID(s) (optional)
    bbox = '' # str | Geographic bounding box (lat0, lon0, lat1, lon1) (optional)
    format = 'format_example' # str | Format (optional)

    try:
        # Airport info
        api_instance.data_airport(ids=ids, bbox=bbox, format=format)
    except ApiException as e:
        print("Exception when calling DataApi->data_airport: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DataApi* | [**data_airport**](docs/DataApi.md#data_airport) | **GET** /api/data/airport | Airport info
*DataApi* | [**data_area_fcst**](docs/DataApi.md#data_area_fcst) | **GET** /api/data/areafcst | US Area Forecasts
*DataApi* | [**data_cwa**](docs/DataApi.md#data_cwa) | **GET** /api/data/cwa | CWSU Center Advisories
*DataApi* | [**data_fcst_disc**](docs/DataApi.md#data_fcst_disc) | **GET** /api/data/fcstdisc | US Forecast Discussions
*DataApi* | [**data_feature**](docs/DataApi.md#data_feature) | **GET** /api/data/feature | Feature info
*DataApi* | [**data_fix**](docs/DataApi.md#data_fix) | **GET** /api/data/fix | Naviagtional fix info
*DataApi* | [**data_gairmet**](docs/DataApi.md#data_gairmet) | **GET** /api/data/gairmet | US Graphical AIRMETs
*DataApi* | [**data_metars**](docs/DataApi.md#data_metars) | **GET** /api/data/metar | METARs
*DataApi* | [**data_mis**](docs/DataApi.md#data_mis) | **GET** /api/data/mis | Meteorological Information Statement
*DataApi* | [**data_navaid**](docs/DataApi.md#data_navaid) | **GET** /api/data/navaid | Navigational aid info
*DataApi* | [**data_obstacle**](docs/DataApi.md#data_obstacle) | **GET** /api/data/obstacle | Obstacle info
*DataApi* | [**data_pirepphp**](docs/DataApi.md#data_pirepphp) | **GET** /api/data/pirep | Pilot Reports
*DataApi* | [**data_sigmet**](docs/DataApi.md#data_sigmet) | **GET** /api/data/airsigmet | Domestic AIRMETs/SIGMETs
*DataApi* | [**data_station_info**](docs/DataApi.md#data_station_info) | **GET** /api/data/stationinfo | Station info
*DataApi* | [**data_taf**](docs/DataApi.md#data_taf) | **GET** /api/data/taf | TAFs
*DataApi* | [**data_wind_temp**](docs/DataApi.md#data_wind_temp) | **GET** /api/data/windtemp | Wind/Temp Point Data
*DataApi* | [**datai_sigmet**](docs/DataApi.md#datai_sigmet) | **GET** /api/data/isigmet | International SIGMETs
*DataserverApi* | [**dataserver_airep**](docs/DataserverApi.md#dataserver_airep) | **GET** /api/data/dataserver?requestType&#x3D;retrieve&amp;dataSource&#x3D;aircraftreports | Dataserver for AIREPs and PIREPs
*DataserverApi* | [**dataserver_gairmet**](docs/DataserverApi.md#dataserver_gairmet) | **GET** /api/data/dataserver?requestType&#x3D;retrieve&amp;dataSource&#x3D;gairmets | Dataserver for G-AIRMETs
*DataserverApi* | [**dataserver_metars**](docs/DataserverApi.md#dataserver_metars) | **GET** /api/data/dataserver?requestType&#x3D;retrieve&amp;dataSource&#x3D;metars | Dataserver for METARs
*DataserverApi* | [**dataserver_sigmet**](docs/DataserverApi.md#dataserver_sigmet) | **GET** /api/data/dataserver?requestType&#x3D;retrieve&amp;dataSource&#x3D;airsigmets | Dataserver for AIRMETs and SIGMETs
*DataserverApi* | [**dataserver_tafs**](docs/DataserverApi.md#dataserver_tafs) | **GET** /api/data/dataserver?requestType&#x3D;retrieve&amp;dataSource&#x3D;tafs | Dataserver for TAFs


## Documentation For Models

 - [DataCWA200Response](docs/DataCWA200Response.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author





            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
    "name": "awc_client",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": "OpenAPI, OpenAPI-Generator, AviationWeather.gov API",
    "author": "OpenAPI Generator Community",
    "author_email": "team@openapitools.org",
    "download_url": "https://files.pythonhosted.org/packages/84/71/7cbdc9cb1d066c24256b1397ed4e856fa39837f4988a4dc1c3270c31abc0/awc_client-1.0.1.tar.gz",
    "platform": null,
    "description": "# awc-client\nNew data API of AviationWeather.gov. This supercedes the ADDS Data Server and AviationWeather Web Services.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 3.12\n- Package version: 1.0.0\n- Generator version: 7.10.0-SNAPSHOT\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport awc_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport awc_client\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport awc_client\nfrom awc_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = awc_client.Configuration(\n    host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith awc_client.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = awc_client.DataApi(api_client)\n    ids = 'KMCI' # str | Station ID(s) (optional)\n    bbox = '' # str | Geographic bounding box (lat0, lon0, lat1, lon1) (optional)\n    format = 'format_example' # str | Format (optional)\n\n    try:\n        # Airport info\n        api_instance.data_airport(ids=ids, bbox=bbox, format=format)\n    except ApiException as e:\n        print(\"Exception when calling DataApi->data_airport: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DataApi* | [**data_airport**](docs/DataApi.md#data_airport) | **GET** /api/data/airport | Airport info\n*DataApi* | [**data_area_fcst**](docs/DataApi.md#data_area_fcst) | **GET** /api/data/areafcst | US Area Forecasts\n*DataApi* | [**data_cwa**](docs/DataApi.md#data_cwa) | **GET** /api/data/cwa | CWSU Center Advisories\n*DataApi* | [**data_fcst_disc**](docs/DataApi.md#data_fcst_disc) | **GET** /api/data/fcstdisc | US Forecast Discussions\n*DataApi* | [**data_feature**](docs/DataApi.md#data_feature) | **GET** /api/data/feature | Feature info\n*DataApi* | [**data_fix**](docs/DataApi.md#data_fix) | **GET** /api/data/fix | Naviagtional fix info\n*DataApi* | [**data_gairmet**](docs/DataApi.md#data_gairmet) | **GET** /api/data/gairmet | US Graphical AIRMETs\n*DataApi* | [**data_metars**](docs/DataApi.md#data_metars) | **GET** /api/data/metar | METARs\n*DataApi* | [**data_mis**](docs/DataApi.md#data_mis) | **GET** /api/data/mis | Meteorological Information Statement\n*DataApi* | [**data_navaid**](docs/DataApi.md#data_navaid) | **GET** /api/data/navaid | Navigational aid info\n*DataApi* | [**data_obstacle**](docs/DataApi.md#data_obstacle) | **GET** /api/data/obstacle | Obstacle info\n*DataApi* | [**data_pirepphp**](docs/DataApi.md#data_pirepphp) | **GET** /api/data/pirep | Pilot Reports\n*DataApi* | [**data_sigmet**](docs/DataApi.md#data_sigmet) | **GET** /api/data/airsigmet | Domestic AIRMETs/SIGMETs\n*DataApi* | [**data_station_info**](docs/DataApi.md#data_station_info) | **GET** /api/data/stationinfo | Station info\n*DataApi* | [**data_taf**](docs/DataApi.md#data_taf) | **GET** /api/data/taf | TAFs\n*DataApi* | [**data_wind_temp**](docs/DataApi.md#data_wind_temp) | **GET** /api/data/windtemp | Wind/Temp Point Data\n*DataApi* | [**datai_sigmet**](docs/DataApi.md#datai_sigmet) | **GET** /api/data/isigmet | International SIGMETs\n*DataserverApi* | [**dataserver_airep**](docs/DataserverApi.md#dataserver_airep) | **GET** /api/data/dataserver?requestType&#x3D;retrieve&amp;dataSource&#x3D;aircraftreports | Dataserver for AIREPs and PIREPs\n*DataserverApi* | [**dataserver_gairmet**](docs/DataserverApi.md#dataserver_gairmet) | **GET** /api/data/dataserver?requestType&#x3D;retrieve&amp;dataSource&#x3D;gairmets | Dataserver for G-AIRMETs\n*DataserverApi* | [**dataserver_metars**](docs/DataserverApi.md#dataserver_metars) | **GET** /api/data/dataserver?requestType&#x3D;retrieve&amp;dataSource&#x3D;metars | Dataserver for METARs\n*DataserverApi* | [**dataserver_sigmet**](docs/DataserverApi.md#dataserver_sigmet) | **GET** /api/data/dataserver?requestType&#x3D;retrieve&amp;dataSource&#x3D;airsigmets | Dataserver for AIRMETs and SIGMETs\n*DataserverApi* | [**dataserver_tafs**](docs/DataserverApi.md#dataserver_tafs) | **GET** /api/data/dataserver?requestType&#x3D;retrieve&amp;dataSource&#x3D;tafs | Dataserver for TAFs\n\n\n## Documentation For Models\n\n - [DataCWA200Response](docs/DataCWA200Response.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\nEndpoints do not require authorization.\n\n\n## Author\n\n\n\n\n",
    "bugtrack_url": null,
    "license": "NoLicense",
    "summary": "AviationWeather.gov API",
    "version": "1.0.1",
    "project_urls": {
        "Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
        "Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
    },
    "split_keywords": [
        "openapi",
        " openapi-generator",
        " aviationweather.gov api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7bf2a8878f7708d6379703df082f0c8fab87c3bbd0e3a2ad2ee0b205f76f2d05",
                "md5": "39e651d32fd79f2091c65df0bec2bf8e",
                "sha256": "229b380fe6740725e317e76ba9c924e32c8b6145e16e97fa9a9b6ff9708d509e"
            },
            "downloads": -1,
            "filename": "awc_client-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "39e651d32fd79f2091c65df0bec2bf8e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 32034,
            "upload_time": "2024-10-25T15:09:47",
            "upload_time_iso_8601": "2024-10-25T15:09:47.915191Z",
            "url": "https://files.pythonhosted.org/packages/7b/f2/a8878f7708d6379703df082f0c8fab87c3bbd0e3a2ad2ee0b205f76f2d05/awc_client-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "84717cbdc9cb1d066c24256b1397ed4e856fa39837f4988a4dc1c3270c31abc0",
                "md5": "794decf13cfc0a7f0ca3973403f5572f",
                "sha256": "fb56dceffb9418316aaacc90fa9b553496d5a30dde5d621b8ec8d2590a0915a0"
            },
            "downloads": -1,
            "filename": "awc_client-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "794decf13cfc0a7f0ca3973403f5572f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 27904,
            "upload_time": "2024-10-25T15:09:48",
            "upload_time_iso_8601": "2024-10-25T15:09:48.832872Z",
            "url": "https://files.pythonhosted.org/packages/84/71/7cbdc9cb1d066c24256b1397ed4e856fa39837f4988a4dc1c3270c31abc0/awc_client-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-25 15:09:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "GIT_USER_ID",
    "github_project": "GIT_REPO_ID",
    "github_not_found": true,
    "lcname": "awc_client"
}
        
Elapsed time: 0.36875s