Metadata-Version: 2.4
Name: aviationtools
Version: 0.1.1
Summary: A collection of aviation-related tools and utilities.
Author-email: "George L. Carlson II" <carlsongeorge61@yahoo.com>
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: License.txt
Dynamic: license-file

# Project name:  
aviationtools

## Author:  
George L. Carlson II  
email: carlsongeorge61@yahoo.com
Website or  GitHub link None at this time

## License:  
This project is licensed under the MIT License - see the LICENSE file for details.

## Description:  
This project is a collection of tools and utilities for aviation enthusiasts, pilots, and professionals.  
It currently includes functions to calculate the distance between two points  
on the earth's surface given the decimal degree of latitude and longitude for  
each point. Included is a function tha calcutaes the distance between two  
airports given their ICAO_ID. Additionally the aviation package includes a  
function to determine the ICAO_ID by querying an airports database by  
CITY by STATE.

## Usage:  
To use the aviationtools package, pip install aviationtools into your virtual
environment, then you can import aviationtools into your Python script 
and call the available functions.  

For example, to calculate the distance between two points, you can use the  
point_to_point(lat1, long1, lat2, long2, mode) function where lat and long parameters
are in degree decimal format and mode is "NULL".

To calculate the distance between two airports call the airport_to_airport(airport1, airport2)  
function where airport1 and airport2 are the ICAO_ID of the airports. Example  
KBUF and KTPA if you are flying from Buffalo Ny to Tampa Fl.  

To determine the ICAO_ID of an airport by city and state, call the  
get_icao_code("CITY", "STATE_CODE"). Example get_icao_code("BUFFALO", "NY")  
and the function will return all the ICAO codes found in Buffalo NY and the
User can then select the airport interested in and use that ICAO code to calculate 
the distance to another airport. CITY and STATE_CODE are case sensitive and 
must be entered in capital letters.  

## Contributing:  

## Versioning:  
Version 0.1.0




`

 
