diff --git a/README.md b/README.md index a570639..0776f53 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,14 @@ # AeroApi Python -The (Unofficial) FlightAware AeroAPI Python Wrapper is a Python package that provides a convenient and easy-to-use interface for interacting with the FlightAware AeroAPI. This package simplifies the process of making API calls to FlightAware, retrieving and processing flight data, and integrating it into your Python applications. +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 @@ -10,6 +17,23 @@ pip install aeroapi-python ``` ### Using test pypi, install with this command. -'''bash +```bash pip install --index-url https://pypi.org/simple/ --extra-index-url https://test.pypi.org/simple/ aeroapi-python -''' \ No newline at end of file +``` + +## Usage + +```python +from aeroapi_python import AeroApi + +# initialize with your AeroAPI username and API Key +aero_api = AeroAPI('your-api-key') +``` + +## License + +[MIT](https://choosealicense.com/licenses/mit/) + +## Authors + +- [@derens99](https://www.github.com/derens99) \ No newline at end of file diff --git a/aeroapi_python/AeroAPI.py b/aeroapi_python/AeroAPI.py index 7249801..e635830 100644 --- a/aeroapi_python/AeroAPI.py +++ b/aeroapi_python/AeroAPI.py @@ -1,4 +1,3 @@ -from typing import Optional from .Operators import Operators from .APICaller import APICaller from .Airports import Airports @@ -6,7 +5,6 @@ from .Miscellaneous import Miscellaneous from .Flights import Flights - class AeroAPI: """ A class for interacting with the FlightAware AeroAPI. diff --git a/setup.py b/setup.py index ad7b697..df482af 100644 --- a/setup.py +++ b/setup.py @@ -15,7 +15,7 @@ setuptools.setup( name="aeroapi-python", - version="1.1.1", + version="1.1.2", description='FlightAware AeroAPI Caller for Python', long_description=readme_path.read_text(), long_description_content_type="text/markdown",