coordconverterjb 0.1.0__tar.gz

coordconverterjb-0.1.0/LICENSE

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

coordconverterjb-0.1.0/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: coordconverterjb
+Version: 0.1.0
+Summary: this package converts the coordinates from degrees to decimals and vice versa
+License: MIT
+License-File: LICENSE
+Author: James Blessings
+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
+
+# coordconverterjb
+
+this package converts the coordinates from degrees to decimals and vice versa
+
+## Installation
+
+```bash
+$ pip install coordconverterjb
+```
+
+## Usage
+
+- TODO
+
+## Contributing
+
+Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.
+
+## License
+
+`coordconverterjb` was created by James Blessings. It is licensed under the terms of the MIT license.
+
+## Credits
+
+`coordconverterjb` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).
+

coordconverterjb-0.1.0/README.md

@@ -0,0 +1,25 @@
+# coordconverterjb
+
+this package converts the coordinates from degrees to decimals and vice versa
+
+## Installation
+
+```bash
+$ pip install coordconverterjb
+```
+
+## Usage
+
+- TODO
+
+## Contributing
+
+Interested in contributing? Check out the contributing guidelines. Please note that this project is released with a Code of Conduct. By contributing to this project, you agree to abide by its terms.
+
+## License
+
+`coordconverterjb` was created by James Blessings. It is licensed under the terms of the MIT license.
+
+## Credits
+
+`coordconverterjb` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).

coordconverterjb-0.1.0/pyproject.toml

@@ -0,0 +1,15 @@
+[tool.poetry]
+name = "coordconverterjb"
+version = "0.1.0"
+description = "this package converts the coordinates from degrees to decimals and vice versa"
+authors = ["James Blessings"]
+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"

coordconverterjb-0.1.0/src/coordconverterjb/__init__.py

@@ -0,0 +1,3 @@
+# read version from installed package
+from importlib.metadata import version
+__version__ = version("coordconverterjb")

coordconverterjb-0.1.0/src/coordconverterjb/coordconverterjb.py

@@ -0,0 +1,161 @@
+
+"""Convert geographic coordinates between DMS and decimal degrees.
+
+Examples
+--------
+>>> to_decimal((15, 47, 0, "S"), (35, 0, 0, "E"))
+(-15.783333333333333, 35.0)
+
+>>> to_degree(-15.783333333333333, 35.0)
+((15, 47, 0.0, 'S'), (35, 0, 0.0, 'E'))
+"""
+
+from typing import Tuple, Union
+
+DMSCoordinate = Tuple[int, int, float, str]
+DecimalCoordinate = Tuple[float, float]
+
+
+def to_decimal(
+    latitude: DMSCoordinate,
+    longitude: DMSCoordinate,
+) -> DecimalCoordinate:
+    """Convert latitude and longitude from 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 of float
+        Decimal latitude and decimal longitude. Southern and western
+        coordinates are negative.
+
+    Examples
+    --------
+    >>> to_decimal((15, 47, 0, "S"), (35, 0, 0, "E"))
+    (-15.783333333333333, 35.0)
+    >>> to_decimal((51, 30, 0, "N"), (0, 7, 0, "W"))
+    (51.5, -0.11666666666666667)
+    """
+    def convert_one(coordinate, valid_directions, max_degrees):
+        if len(coordinate) != 4:
+            raise ValueError(
+                "Each DMS coordinate must contain degrees, "
+                "minutes, seconds and direction."
+            )
+
+        degrees, minutes, seconds, direction = coordinate
+        direction = direction.upper() if isinstance(direction, str) else ""
+
+        if direction not in valid_directions:
+            raise ValueError(
+                f"Direction must be one of {valid_directions}."
+            )
+
+        if not all(
+            isinstance(value, (int, float))
+            and not isinstance(value, bool)
+            for value in (degrees, minutes, seconds)
+        ):
+            raise TypeError("Degrees, minutes and seconds must be numeric.")
+
+        if degrees < 0 or degrees > max_degrees:
+            raise ValueError(
+                f"Degrees must be between 0 and {max_degrees}."
+            )
+
+        if not 0 <= minutes < 60 or not 0 <= seconds < 60:
+            raise ValueError("Minutes and seconds must be in [0, 60).")
+
+        if degrees == max_degrees and (minutes != 0 or seconds != 0):
+            raise ValueError(
+                f"At {max_degrees} degrees, minutes and seconds must be zero."
+            )
+
+        decimal_value = degrees + minutes / 60 + seconds / 3600
+
+        if direction in ("S", "W"):
+            decimal_value = -decimal_value
+
+        return decimal_value
+
+    decimal_latitude = convert_one(latitude, ("N", "S"), 90)
+    decimal_longitude = convert_one(longitude, ("E", "W"), 180)
+
+    return decimal_latitude, decimal_longitude
+
+
+def to_degree(
+    latitude: float,
+    longitude: float,
+) -> Tuple[DMSCoordinate, DMSCoordinate]:
+    """Convert decimal latitude and longitude to DMS coordinates.
+
+    Parameters
+    ----------
+    latitude : float
+        Decimal latitude between -90 and 90 degrees.
+    longitude : float
+        Decimal longitude between -180 and 180 degrees.
+
+    Returns
+    -------
+    tuple
+        A pair of DMS tuples in the form
+        ((degrees, minutes, seconds, direction),
+         (degrees, minutes, seconds, direction)).
+        Seconds are returned as floats.
+
+    Examples
+    --------
+    >>> to_degree(-15.783333333333333, 35.0)
+    ((15, 47, 0.0, 'S'), (35, 0, 0.0, 'E'))
+    >>> to_degree(51.5, -0.11666666666666667)
+    ((51, 30, 0.0, 'N'), (0, 7, 0.0, 'W'))
+    """
+    def convert_one(value, max_degrees, positive_direction,
+                    negative_direction):
+        if not isinstance(value, (int, float)) or isinstance(value, bool):
+            raise TypeError("Coordinates must be numeric.")
+
+        if not -max_degrees <= value <= max_degrees:
+            raise ValueError(
+                f"Coordinate must be between {-max_degrees} "
+                f"and {max_degrees}."
+            )
+
+        direction = negative_direction if value < 0 else positive_direction
+        absolute_value = abs(value)
+
+        degrees = int(absolute_value)
+        minutes_full = (absolute_value - degrees) * 60
+        minutes = int(minutes_full)
+        seconds = round((minutes_full - minutes) * 60, 6)
+
+        # Handle rounding that reaches 60 seconds or 60 minutes.
+        if seconds >= 60:
+            seconds = 0.0
+            minutes += 1
+
+        if minutes >= 60:
+            minutes = 0
+            degrees += 1
+
+        if degrees > max_degrees:
+            degrees = max_degrees
+            minutes = 0
+            seconds = 0.0
+
+        return degrees, minutes, seconds, direction
+
+    dms_latitude = convert_one(latitude, 90, "N", "S")
+    dms_longitude = convert_one(longitude, 180, "E", "W")
+
+    return dms_latitude, dms_longitude