| Name | flight-radar JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | None |
| Summary | An unofficial Python SDK for the FlightRadar24 API. |
| upload_time | 2025-07-28 06:20:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | Copyright (c) 2025 <copyright holders> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
flight-radar
api
sdk
aviation
flights
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Flight Radar API Client
This project provides a Python client for interacting with the Flight Radar API. It simplifies the process of fetching flight-related data, such as live and historic flight positions, flight summaries, and airline and airport information.
## Features
- **Live Flight Data:** Get real-time flight positions for aircraft around the world.
- **Historic Flight Data:** Access historical flight data, including positions, summaries, and events.
- **Flight Details:** Retrieve detailed information about specific flights, including their tracks.
- **Airline & Airport Information:** Look up details about airlines and airports.
- **API Usage Monitoring:** Check your API usage statistics.
## Installation
To install the Flight Radar API Client, you can use pip:
```bash
pip install flight-radar
```
## Quickstart
Here's a simple example of how to use the client to get live flight positions:
```python
from flight_radar.factory import get_flight_radar_client
from flight_radar.models import LiveFlightPositionRequest
# Create a flight radar client
client = get_flight_radar_client()
# Create a request to get the live flight positions
request = LiveFlightPositionRequest(
limit=10,
# Add any other parameters you might need
)
# Get the live flight positions
positions = client.get_live_flight_positions(request)
# Print the positions
for position in positions:
print(position)
```
This will output a list of `FlightPosition` objects, each containing information about a live flight.
## Documentation
For more detailed information about the available methods and models, please refer to the [official documentation](https://amirmuminovic.github.io/flight-radar/).
## Contributing
Contributions are welcome! If you'd like to contribute, please check out the [CONTRIBUTING.md](CONTRIBUTING.md).
## Local Development
To set up the project for local development, follow these steps. This project uses `uv` for package management.
1. **Install uv:**
Follow the [official installation guide](https://docs.astral.sh/uv/getting-started/installation/) to install `uv`.
2. **Create and activate a virtual environment:**
To run the examples, you first need to create and activate a virtual environment:
```bash
uv venv
source .venv/bin/activate
```
3. **Install dependencies:**
Install the project dependencies, including the development dependencies:
```bash
uv sync --extra dev
```
4. **Set up pre-commit hooks:**
This project uses pre-commit hooks to ensure code quality. Install them by running:
```bash
uv run pre-commit install
```
5. **Run an example:**
Then, you can run any of the example scripts:
```bash
python examples/alert_when_flight_enters_circular_area.py
```
Now you are all set up to run the project locally and contribute to its development.
Raw data
{
"_id": null,
"home_page": null,
"name": "flight-radar",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "flight-radar, api, sdk, aviation, flights",
"author": null,
"author_email": "Amir Muminovic <amir.muminovic192@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/1e/93/83c09abb4c26e4a042a81cf36491f7d26f4c6945ade4240b9a6a3dc4327d/flight_radar-0.0.3.tar.gz",
"platform": null,
"description": "# Flight Radar API Client\n\nThis project provides a Python client for interacting with the Flight Radar API. It simplifies the process of fetching flight-related data, such as live and historic flight positions, flight summaries, and airline and airport information.\n\n## Features\n\n- **Live Flight Data:** Get real-time flight positions for aircraft around the world.\n- **Historic Flight Data:** Access historical flight data, including positions, summaries, and events.\n- **Flight Details:** Retrieve detailed information about specific flights, including their tracks.\n- **Airline & Airport Information:** Look up details about airlines and airports.\n- **API Usage Monitoring:** Check your API usage statistics.\n\n## Installation\n\nTo install the Flight Radar API Client, you can use pip:\n\n```bash\npip install flight-radar\n```\n\n## Quickstart\n\nHere's a simple example of how to use the client to get live flight positions:\n\n```python\nfrom flight_radar.factory import get_flight_radar_client\nfrom flight_radar.models import LiveFlightPositionRequest\n\n# Create a flight radar client\nclient = get_flight_radar_client()\n\n# Create a request to get the live flight positions\nrequest = LiveFlightPositionRequest(\n limit=10,\n # Add any other parameters you might need\n)\n\n# Get the live flight positions\npositions = client.get_live_flight_positions(request)\n\n# Print the positions\nfor position in positions:\n print(position)\n```\n\nThis will output a list of `FlightPosition` objects, each containing information about a live flight.\n\n## Documentation\n\nFor more detailed information about the available methods and models, please refer to the [official documentation](https://amirmuminovic.github.io/flight-radar/).\n\n## Contributing\n\nContributions are welcome! If you'd like to contribute, please check out the [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## Local Development\n\nTo set up the project for local development, follow these steps. This project uses `uv` for package management.\n\n1. **Install uv:**\n\n Follow the [official installation guide](https://docs.astral.sh/uv/getting-started/installation/) to install `uv`.\n\n2. **Create and activate a virtual environment:**\n\n To run the examples, you first need to create and activate a virtual environment:\n\n ```bash\n uv venv\n source .venv/bin/activate\n ```\n\n3. **Install dependencies:**\n\n Install the project dependencies, including the development dependencies:\n ```bash\n uv sync --extra dev\n ```\n\n4. **Set up pre-commit hooks:**\n\n This project uses pre-commit hooks to ensure code quality. Install them by running:\n ```bash\n uv run pre-commit install\n ```\n\n5. **Run an example:**\n\n Then, you can run any of the example scripts:\n\n ```bash\n python examples/alert_when_flight_enters_circular_area.py\n ```\n\nNow you are all set up to run the project locally and contribute to its development.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2025 <copyright holders> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "An unofficial Python SDK for the FlightRadar24 API.",
"version": "0.0.3",
"project_urls": {
"Bug Tracker": "https://github.com/amirmuminovic/flight_radar/issues",
"Documentation": "https://amirmuminovic.github.io/flight_radar/",
"Homepage": "https://github.com/amirmuminovic/flight_radar",
"Repository": "https://github.com/amirmuminovic/flight_radar"
},
"split_keywords": [
"flight-radar",
" api",
" sdk",
" aviation",
" flights"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2aa6d41036bc137164304e04064e3a7b4c17e45d4d12787002bb861b3ec6cc7b",
"md5": "f19c828ba59a354bf57fd69480573bb9",
"sha256": "99d717f2213f06e87fb5e6dcf3e1454b8637959c81fb963f20d5b7e7b9bf492b"
},
"downloads": -1,
"filename": "flight_radar-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f19c828ba59a354bf57fd69480573bb9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 26362,
"upload_time": "2025-07-28T06:20:07",
"upload_time_iso_8601": "2025-07-28T06:20:07.411274Z",
"url": "https://files.pythonhosted.org/packages/2a/a6/d41036bc137164304e04064e3a7b4c17e45d4d12787002bb861b3ec6cc7b/flight_radar-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1e9383c09abb4c26e4a042a81cf36491f7d26f4c6945ade4240b9a6a3dc4327d",
"md5": "95d7dfc32436e24371a3e70d8e339d48",
"sha256": "ed16789c0e165acaa4b689c9b311254953ae79ef24c71426f207116c9c89d26d"
},
"downloads": -1,
"filename": "flight_radar-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "95d7dfc32436e24371a3e70d8e339d48",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 19218,
"upload_time": "2025-07-28T06:20:08",
"upload_time_iso_8601": "2025-07-28T06:20:08.523453Z",
"url": "https://files.pythonhosted.org/packages/1e/93/83c09abb4c26e4a042a81cf36491f7d26f4c6945ade4240b9a6a3dc4327d/flight_radar-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-28 06:20:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "amirmuminovic",
"github_project": "flight_radar",
"github_not_found": true,
"lcname": "flight-radar"
}
