Skip to content

Commit

Permalink
Repo changes
Browse files Browse the repository at this point in the history
  • Loading branch information
derens99 committed May 28, 2023
1 parent 7cd7987 commit 301b2d9
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 6 deletions.
30 changes: 27 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
'''
```

## 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)
2 changes: 0 additions & 2 deletions aeroapi_python/AeroAPI.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
from typing import Optional
from .Operators import Operators
from .APICaller import APICaller
from .Airports import Airports
from .History import History
from .Miscellaneous import Miscellaneous
from .Flights import Flights


class AeroAPI:
"""
A class for interacting with the FlightAware AeroAPI.
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 301b2d9

Please sign in to comment.