# AeroApi Python
Python wrapper for the FlightAware's AeroAPI
## Description
AeroAPI (formerly FlightXML) is FlightAware's live flight data API that provides powerful, reliable information about real-time and historical flight information. This Python wrapper allows for easier interaction with the AeroAPI from Python applications.
## FlightAware AeroAPI Reference
[AeroAPI](https://flightaware.com/aeroapi)
## Installation
```bash
pip install aeroapi-python
```
### Using test pypi, install with this command.
```bash
pip install --index-url https://pypi.org/simple/ --extra-index-url https://test.pypi.org/simple/ aeroapi-python
```
## Usage
### AeroAPI Class
The AeroAPI class is the main class for interacting with the FlightAware AeroAPI. It provides access to various resources such as airports, operators, flights, and more.
#### Initialization
To use the AeroAPI class, you need to create an instance of it by passing your API key as an argument to the constructor:
```python
from AeroAPI import AeroAPI
api_key = 'your-api-key'
aeroapi = AeroAPI(api_key)
```
### Airports
The Airports class provides methods for retrieving information about airports. You can access an instance of the Airports class through the airports attribute of the AeroAPI instance:
```python
airports = aeroapi.airports
```
#### Methods
- get_airport_info(airport_code: str) -> dict: Returns information about the specified airport.
```python
airport_info = airports.get_airport_info('KLAX')
```
- search_airports(query: str) -> list: Searches for airports that match the specified query.
```python
airport_list = airports.search_airports('Los Angeles')
```
- get_nearby_airports(latitude: float, longitude: float, radius: int) -> list: Returns a list of airports near the specified latitude and longitude within the specified radius.
```python
airport_list = airports.get_nearby_airports(33.9425, -118.408056, 10)
```
#### Example Usage
```python
from AeroAPI import AeroAPI
api_key = 'your-api-key'
aeroapi = AeroAPI(api_key)
airports = aeroapi.airports
airport_info = airports.get_airport_info('KLAX')
print(airport_info)
```
## License
[MIT](https://choosealicense.com/licenses/mit/)
## Authors
- [@derens99](https://www.github.com/derens99)
Raw data
{
"_id": null,
"home_page": "https://github.com/derens99/aeroapi-python",
"name": "aeroapi-python",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": "",
"keywords": "python aeroapi flightaware flightaware-api flightaware-aeroapi flightaware-aeroapi-python flightaware-aeroapi-python3 flightaware-aeroapi-python3.5 flightaware-aeroapi-python3.6 flightaware-aeroapi-python3.7 flightaware-aeroapi-python3.8 flightaware-aeroapi-python3.9",
"author": "Deren S",
"author_email": "derens9999@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b1/e3/d9ee84c43658e2db4ee29599c9439307ae2929b98fca71a2645774a1f3c3/aeroapi-python-1.1.4.tar.gz",
"platform": null,
"description": "\n# AeroApi Python\n\nPython wrapper for the FlightAware's AeroAPI\n\n## Description\n\nAeroAPI (formerly FlightXML) is FlightAware's live flight data API that provides powerful, reliable information about real-time and historical flight information. This Python wrapper allows for easier interaction with the AeroAPI from Python applications.\n\n## FlightAware AeroAPI Reference\n[AeroAPI](https://flightaware.com/aeroapi)\n\n## Installation\n\n```bash\npip install aeroapi-python\n```\n \n### Using test pypi, install with this command.\n```bash\npip install --index-url https://pypi.org/simple/ --extra-index-url https://test.pypi.org/simple/ aeroapi-python\n```\n\n## Usage\n\n### AeroAPI Class\nThe AeroAPI class is the main class for interacting with the FlightAware AeroAPI. It provides access to various resources such as airports, operators, flights, and more.\n\n#### Initialization\nTo use the AeroAPI class, you need to create an instance of it by passing your API key as an argument to the constructor:\n\n```python\nfrom AeroAPI import AeroAPI\n\napi_key = 'your-api-key'\naeroapi = AeroAPI(api_key)\n```\n\n### Airports\nThe Airports class provides methods for retrieving information about airports. You can access an instance of the Airports class through the airports attribute of the AeroAPI instance:\n\n```python\nairports = aeroapi.airports\n```\n\n#### Methods\n\n- get_airport_info(airport_code: str) -> dict: Returns information about the specified airport.\n \n ```python\n airport_info = airports.get_airport_info('KLAX')\n ```\n\n- search_airports(query: str) -> list: Searches for airports that match the specified query.\n \n ```python\n airport_list = airports.search_airports('Los Angeles')\n ```\n\n- get_nearby_airports(latitude: float, longitude: float, radius: int) -> list: Returns a list of airports near the specified latitude and longitude within the specified radius.\n \n ```python\n airport_list = airports.get_nearby_airports(33.9425, -118.408056, 10)\n ```\n\n#### Example Usage\n\n```python \nfrom AeroAPI import AeroAPI\n\napi_key = 'your-api-key'\naeroapi = AeroAPI(api_key)\n\nairports = aeroapi.airports\nairport_info = airports.get_airport_info('KLAX')\n\nprint(airport_info)\n```\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n\n## Authors\n\n- [@derens99](https://www.github.com/derens99)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "FlightAware AeroAPI Caller for Python",
"version": "1.1.4",
"project_urls": {
"Homepage": "https://github.com/derens99/aeroapi-python"
},
"split_keywords": [
"python",
"aeroapi",
"flightaware",
"flightaware-api",
"flightaware-aeroapi",
"flightaware-aeroapi-python",
"flightaware-aeroapi-python3",
"flightaware-aeroapi-python3.5",
"flightaware-aeroapi-python3.6",
"flightaware-aeroapi-python3.7",
"flightaware-aeroapi-python3.8",
"flightaware-aeroapi-python3.9"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b96170da5519f94d4d0f72de7cb04d6cbeebfe5f254d43821b88f860f4e47d34",
"md5": "856bd8113fc0d8e796f40a93d9b55abd",
"sha256": "d446e1ab9a1354cf37c971dcf28fdb79df15944b589d9610cb23fb31e6926a39"
},
"downloads": -1,
"filename": "aeroapi_python-1.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "856bd8113fc0d8e796f40a93d9b55abd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 12510,
"upload_time": "2023-05-31T06:58:23",
"upload_time_iso_8601": "2023-05-31T06:58:23.827464Z",
"url": "https://files.pythonhosted.org/packages/b9/61/70da5519f94d4d0f72de7cb04d6cbeebfe5f254d43821b88f860f4e47d34/aeroapi_python-1.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b1e3d9ee84c43658e2db4ee29599c9439307ae2929b98fca71a2645774a1f3c3",
"md5": "ba825aeb059bff2308c08a4bce1f28f1",
"sha256": "5a41d6f5b52d3478500048a28df1659780d29386dd2bf9a84451cc5af31be0cb"
},
"downloads": -1,
"filename": "aeroapi-python-1.1.4.tar.gz",
"has_sig": false,
"md5_digest": "ba825aeb059bff2308c08a4bce1f28f1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 10266,
"upload_time": "2023-05-31T06:58:25",
"upload_time_iso_8601": "2023-05-31T06:58:25.803889Z",
"url": "https://files.pythonhosted.org/packages/b1/e3/d9ee84c43658e2db4ee29599c9439307ae2929b98fca71a2645774a1f3c3/aeroapi-python-1.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-31 06:58:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "derens99",
"github_project": "aeroapi-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "aeroapi-python"
}
JSON
