coordconvertergc 0.1.0__tar.gz

coordconvertergc-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026, Gracious Chinguwo
+
+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.
+

coordconvertergc-0.1.0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: coordconvertergc
+Version: 0.1.0
+Summary: A Python package for converting geographic coordinates between degrees, minutes, seconds and decimal degrees.
+License: MIT
+License-File: LICENSE
+Author: Gracious Chinguwo
+Requires-Python: >=3.12,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Description-Content-Type: text/markdown
+
+# coordconvertergc
+
+A Python package for converting geographic coordinates between degrees, minutes, seconds and decimal degrees.
+
+Created by Gracious Chinguwo
+
+## Installation
+Install the package from PyPi using: 
+pip install coordconvertergc
+
+## Usage
+1. Convert DMS to decimal degrees
+Use to_decimal() to convert latitude and longitude from DMS to decimal degrees. Southern and western coordinates are returned as negative values.
+
+from coordconvertergc import to_decimal
+latitude = (15, 47, 0, "S")
+longitude = (35, 0, 0, "E")
+
+result = to_decimal(latitude, longitude)
+print(result)
+
+Output:
+(-15.783333333333333, 35.0)
+
+2. Convert decimal degrees to DMS
+Use to_degree() to convert decimal-degree latitude and longitude to DMS coordinates.
+
+from coordconvertergc import to_degree
+latitude = -15.783333333333333
+longitude = 35.0
+
+result = to_degree(latitude, longitude)
+print(result)
+
+output:
+((15, 47, 0.0, 'S'), (35, 0, 0.0, 'E'))
+
+## Input Validation 
+The functions validate coordinate ranges, DMS values, and compass directions. Invalid inputs raise a ValueError with an explanatory message.
+
+Example 1: Invalid latitude
+
+to_degree(95, 35)
+
+This raises a ValueError because latitude must be between -90 and 90 degrees.
+
+Example 2: Invalid longitude
+
+to_degree(15, 200)
+
+This raises a ValueError because longitude must be between -180 and 180 degrees.
+
+These checks help ensure that only geographically valid coordinates are converted.
+
+## Contributing
+
+Contributions are welcome. Please read the contributing guidelines and code of conduct before contributing. 
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details. 
+
+## Project links
+- GitHub repository: https://github.com/Chinguwo8/coordconvertergc
+
+- PyPI package: https://pypi.org/project/coordconvertergc/
+
+## Credits
+This package was created using Cookiecutter and the py-pkgs-cookiecutter template
+

coordconvertergc-0.1.0/README.md

@@ -0,0 +1,69 @@
+# coordconvertergc
+
+A Python package for converting geographic coordinates between degrees, minutes, seconds and decimal degrees.
+
+Created by Gracious Chinguwo
+
+## Installation
+Install the package from PyPi using: 
+pip install coordconvertergc
+
+## Usage
+1. Convert DMS to decimal degrees
+Use to_decimal() to convert latitude and longitude from DMS to decimal degrees. Southern and western coordinates are returned as negative values.
+
+from coordconvertergc import to_decimal
+latitude = (15, 47, 0, "S")
+longitude = (35, 0, 0, "E")
+
+result = to_decimal(latitude, longitude)
+print(result)
+
+Output:
+(-15.783333333333333, 35.0)
+
+2. Convert decimal degrees to DMS
+Use to_degree() to convert decimal-degree latitude and longitude to DMS coordinates.
+
+from coordconvertergc import to_degree
+latitude = -15.783333333333333
+longitude = 35.0
+
+result = to_degree(latitude, longitude)
+print(result)
+
+output:
+((15, 47, 0.0, 'S'), (35, 0, 0.0, 'E'))
+
+## Input Validation 
+The functions validate coordinate ranges, DMS values, and compass directions. Invalid inputs raise a ValueError with an explanatory message.
+
+Example 1: Invalid latitude
+
+to_degree(95, 35)
+
+This raises a ValueError because latitude must be between -90 and 90 degrees.
+
+Example 2: Invalid longitude
+
+to_degree(15, 200)
+
+This raises a ValueError because longitude must be between -180 and 180 degrees.
+
+These checks help ensure that only geographically valid coordinates are converted.
+
+## Contributing
+
+Contributions are welcome. Please read the contributing guidelines and code of conduct before contributing. 
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for details. 
+
+## Project links
+- GitHub repository: https://github.com/Chinguwo8/coordconvertergc
+
+- PyPI package: https://pypi.org/project/coordconvertergc/
+
+## Credits
+This package was created using Cookiecutter and the py-pkgs-cookiecutter template

coordconvertergc-0.1.0/pyproject.toml

@@ -0,0 +1,20 @@
+[tool.poetry]
+name = "coordconvertergc"
+version = "0.1.0"
+description = "A Python package for converting geographic coordinates between degrees, minutes, seconds and decimal degrees."
+authors = ["Gracious Chinguwo"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[dependency-groups]
+dev = [
+    "pytest (>=9.1.1,<10.0.0)"
+]

coordconvertergc-0.1.0/src/coordconvertergc/__init__.py

@@ -0,0 +1,4 @@
+# read version from installed package
+from importlib.metadata import version
+__version__ = version("coordconvertergc")
+from .coordconvertergc import to_decimal, to_degree

coordconvertergc-0.1.0/src/coordconvertergc/coordconvertergc.py

@@ -0,0 +1,166 @@
+def to_decimal(latitude, longitude):
+    """
+    Convert latitude and longitude from degrees, minutes, and seconds
+    (DMS) to decimal degrees.
+
+    Parameters
+    ----------
+    latitude : tuple
+        Latitude as (degrees, minutes, seconds, direction).
+        Direction must be N or S.
+    longitude : tuple
+        Longitude as (degrees, minutes, seconds, direction).
+        Direction must be E or W.
+
+    Returns
+    -------
+    tuple
+        A pair containing (latitude, longitude) in decimal degrees.
+        South and west coordinates are negative.
+
+    Raises
+    ------
+    ValueError
+        If the coordinate format, values, or direction is invalid.
+
+    Examples
+    --------
+    >>> to_decimal((15, 47, 0, "S"), (35, 0, 0, "E"))
+    (-15.783333333333333, 35.0)
+    """
+
+    def validate_coordinate(coordinate, coordinate_type):
+        if not isinstance(coordinate, (tuple, list)) or len(coordinate) != 4:
+            raise ValueError(
+                "Coordinate must contain (degrees, minutes, seconds, direction)."
+            )
+
+        degrees, minutes, seconds, direction = coordinate
+
+        if any(
+            isinstance(value, bool) or not isinstance(value, (int, float))
+            for value in (degrees, minutes, seconds)
+        ):
+            raise ValueError("Degrees, minutes, and seconds must be numeric.")
+
+        if not all(
+            value == value and abs(value) != float("inf")
+            for value in (degrees, minutes, seconds)
+        ):
+            raise ValueError("Coordinate values must be finite numbers.")
+
+        if degrees < 0 or minutes < 0 or seconds < 0:
+            raise ValueError("Degrees, minutes, and seconds cannot be negative.")
+
+        if minutes >= 60 or seconds >= 60:
+            raise ValueError("Minutes and seconds must be less than 60.")
+
+        direction = direction.upper() if isinstance(direction, str) else ""
+
+        if coordinate_type == "latitude":
+            if direction not in ("N", "S"):
+                raise ValueError("Latitude direction must be N or S.")
+            maximum = 90
+        else:
+            if direction not in ("E", "W"):
+                raise ValueError("Longitude direction must be E or W.")
+            maximum = 180
+
+        if degrees > maximum or (
+            degrees == maximum and (minutes != 0 or seconds != 0)
+        ):
+            raise ValueError(
+                f"{coordinate_type.title()} cannot exceed {maximum} degrees."
+            )
+
+        return degrees, minutes, seconds, direction
+
+    lat_deg, lat_min, lat_sec, lat_dir = validate_coordinate(
+        latitude, "latitude"
+    )
+    lon_deg, lon_min, lon_sec, lon_dir = validate_coordinate(
+        longitude, "longitude"
+    )
+
+    lat_decimal = lat_deg + (lat_min / 60) + (lat_sec / 3600)
+    lon_decimal = lon_deg + (lon_min / 60) + (lon_sec / 3600)
+
+    if lat_dir == "S":
+        lat_decimal = -lat_decimal
+
+    if lon_dir == "W":
+        lon_decimal = -lon_decimal
+
+    return lat_decimal, lon_decimal
+
+
+def to_degree(latitude, longitude):
+    """
+    Convert decimal-degree latitude and longitude to DMS coordinates.
+
+    Parameters
+    ----------
+    latitude : int or float
+        Latitude in decimal degrees, from -90 to 90.
+    longitude : int or float
+        Longitude in decimal degrees, from -180 to 180.
+
+    Returns
+    -------
+    tuple
+        Two tuples in the format (degrees, minutes, seconds, direction).
+
+    Raises
+    ------
+    ValueError
+        If coordinates are not finite numbers or are outside valid ranges.
+
+    Examples
+    --------
+    >>> to_degree(-15.783333333333333, 35.0)
+    ((15, 47, 0.0, 'S'), (35, 0, 0.0, 'E'))
+    """
+
+    for value, name, maximum in (
+        (latitude, "Latitude", 90),
+        (longitude, "Longitude", 180),
+    ):
+        if (
+            isinstance(value, bool)
+            or not isinstance(value, (int, float))
+            or value != value
+            or abs(value) == float("inf")
+        ):
+            raise ValueError(f"{name} must be a finite number.")
+
+        if not -maximum <= value <= maximum:
+            raise ValueError(f"{name} must be between {-maximum} and {maximum}.")
+
+    lat_direction = "N" if latitude >= 0 else "S"
+    lon_direction = "E" if longitude >= 0 else "W"
+
+    latitude = abs(latitude)
+    longitude = abs(longitude)
+
+    def decimal_to_dms(value, direction):
+        degrees = int(value)
+        minutes_full = (value - degrees) * 60
+        minutes = int(minutes_full)
+        seconds = round((minutes_full - minutes) * 60, 6)
+
+        # Correct rounding that reaches 60 seconds or minutes.
+        if seconds >= 60:
+            seconds = 0.0
+            minutes += 1
+
+        if minutes >= 60:
+            minutes = 0
+            degrees += 1
+
+        return degrees, minutes, seconds, direction
+
+    return (
+        decimal_to_dms(latitude, lat_direction),
+        decimal_to_dms(longitude, lon_direction),
+    )
+