compass-lib 0.0.2__py3-none-any.whl → 0.0.3__py3-none-any.whl

compass_lib/__init__.py

@@ -1,7 +1,117 @@
 # -*- coding: utf-8 -*-
+"""Compass Parser Library.
 
+A Python library for parsing and formatting Compass cave survey data files.
+Supports .DAT (survey data), .MAK (project files), and .PLT (plot files).
+
+Usage:
+    # Load a complete project (MAK + all DAT files)
+    from compass_lib import load_project
+    project = load_project(Path("cave.mak"))
+
+    for file_dir in project.file_directives:
+        print(f"File: {file_dir.file}")
+        if file_dir.data:
+            for trip in file_dir.data.trips:
+                print(f"  Survey: {trip.header.survey_name}")
+
+    # Or load individual files
+    from compass_lib import read_dat_file, read_mak_file
+    trips = read_dat_file(Path("survey.DAT"))
+    directives = read_mak_file(Path("project.MAK"))
 """
-"A library to read Compass Survey files"
-"""
 
-__version__ = "0.0.2"
+__version__ = "0.0.3"
+
+# Constants
+from compass_lib.constants import COMPASS_ENCODING
+from compass_lib.constants import FEET_TO_METERS
+from compass_lib.constants import JSON_ENCODING
+from compass_lib.constants import METERS_TO_FEET
+
+# Enums
+from compass_lib.enums import AzimuthUnit
+from compass_lib.enums import CompassFileType
+from compass_lib.enums import DrawOperation
+from compass_lib.enums import FileFormat
+from compass_lib.enums import InclinationUnit
+from compass_lib.enums import LengthUnit
+from compass_lib.enums import LrudAssociation
+from compass_lib.enums import LrudItem
+from compass_lib.enums import Severity
+from compass_lib.enums import ShotItem
+from compass_lib.errors import CompassParseError
+from compass_lib.errors import CompassParseException
+from compass_lib.errors import SourceLocation
+from compass_lib.interface import CompassInterface
+from compass_lib.io import CancellationToken
+from compass_lib.io import load_project
+from compass_lib.io import read_dat_file
+from compass_lib.io import read_mak_and_dat_files
+from compass_lib.io import read_mak_file
+from compass_lib.io import save_project
+from compass_lib.io import write_dat_file
+from compass_lib.io import write_mak_file
+from compass_lib.models import Bounds
+from compass_lib.models import Location
+from compass_lib.models import NEVLocation
+from compass_lib.project.models import CompassMakFile
+from compass_lib.project.models import FileDirective
+from compass_lib.project.models import LinkStation
+from compass_lib.survey.models import CompassDatFile
+from compass_lib.survey.models import CompassShot
+from compass_lib.survey.models import CompassTrip
+from compass_lib.survey.models import CompassTripHeader
+from compass_lib.validation import days_in_month
+from compass_lib.validation import is_valid_station_name
+from compass_lib.validation import validate_station_name
+
+__all__ = [
+    # Constants
+    "COMPASS_ENCODING",
+    "FEET_TO_METERS",
+    "JSON_ENCODING",
+    "METERS_TO_FEET",
+    # Enums
+    "AzimuthUnit",
+    # Base Models
+    "Bounds",
+    "CancellationToken",
+    # Survey Models
+    "CompassDatFile",
+    "CompassFileType",
+    # I/O
+    "CompassInterface",
+    # Project Models
+    "CompassMakFile",
+    # Errors
+    "CompassParseError",
+    "CompassParseException",
+    "CompassShot",
+    "CompassTrip",
+    "CompassTripHeader",
+    "DrawOperation",
+    "FileDirective",
+    "FileFormat",
+    "InclinationUnit",
+    "LengthUnit",
+    "LinkStation",
+    "Location",
+    "LrudAssociation",
+    "LrudItem",
+    "NEVLocation",
+    "Severity",
+    "ShotItem",
+    "SourceLocation",
+    "days_in_month",
+    # Validation
+    "is_valid_station_name",
+    "load_project",
+    "read_dat_file",
+    "read_mak_and_dat_files",
+    "read_mak_file",
+    "save_project",
+    "validate_station_name",
+    "write_dat_file",
+    "write_mak_file",
+]

compass_lib/commands/__init__.py

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+"""Command-line interface commands for compass_lib."""

compass_lib/commands/convert.py

@@ -1,62 +1,249 @@
-from __future__ import annotations
+# -*- coding: utf-8 -*-
+"""Convert command for Compass files.
+
+Supports bidirectional conversion between Compass native formats (DAT, MAK)
+and JSON format using Pydantic's built-in serialization.
+"""
 
 import argparse
+import json
 from pathlib import Path
 
-from compass_lib.parser import CompassParser
+from compass_lib.constants import COMPASS_ENCODING
+from compass_lib.constants import JSON_ENCODING
+from compass_lib.enums import CompassFileType
+from compass_lib.enums import FileExtension
+from compass_lib.enums import FileFormat
+from compass_lib.enums import FormatIdentifier
+from compass_lib.io import load_project
+from compass_lib.io import read_dat_file
+from compass_lib.project.format import format_mak_file
+from compass_lib.project.models import CompassMakFile
+from compass_lib.survey.format import format_dat_file
+from compass_lib.survey.models import CompassDatFile
+
+
+class ConversionError(Exception):
+    """Error raised for invalid conversion operations."""
+
+
+def detect_file_format(
+    path: Path,
+) -> tuple[FileFormat, CompassFileType | None]:
+    """Detect the file format and type based on extension and content.
+
+    Args:
+        path: File path
+
+    Returns:
+        Tuple of (format_type, file_type) where:
+        - format_type: FileFormat.COMPASS or FileFormat.JSON
+        - file_type: CompassFileType.DAT or CompassFileType.MAK (or None)
+    """
+
+    match f_ext := path.suffix.lower():
+        case FileExtension.DAT.value:
+            return (FileFormat.COMPASS, CompassFileType.DAT)
+
+        case FileExtension.MAK.value:
+            return (FileFormat.COMPASS, CompassFileType.MAK)
+
+        case FileExtension.JSON.value:
+            # Read the file to detect format from content
+            content = path.read_text(encoding=JSON_ENCODING)
+            if (
+                f'"format": "{FormatIdentifier.COMPASS_DAT.value}"' in content
+                or f'"format":"{FormatIdentifier.COMPASS_DAT.value}"' in content
+            ):
+                return (FileFormat.JSON, CompassFileType.DAT)
+
+            if (
+                f'"format": "{FormatIdentifier.COMPASS_MAK.value}"' in content
+                or f'"format":"{FormatIdentifier.COMPASS_MAK.value}"' in content
+            ):
+                return (FileFormat.JSON, CompassFileType.MAK)
+
+            raise ValueError(f"Unknown file type found inside json: `{f_ext}`")
+
+        case _:
+            raise ValueError(f"Unknown file extension: `{f_ext}`")
+
+
+def _convert(
+    input_path: Path,
+    output_path: Path | None = None,
+    target_format: FileFormat | str | None = None,
+) -> str | None:
+    """Convert a file between formats.
+
+    Args:
+        input_path: Input file path
+        output_path: Output file path (None = return as string)
+        target_format: Target format (FileFormat or string 'compass'/'json')
+
+    Returns:
+        Converted content as string if output_path is None,
+        otherwise None (writes to file)
+
+    Raises:
+        ConversionError: If conversion is not valid
+        FileNotFoundError: If input file doesn't exist
+    """
+    if not input_path.exists():
+        raise FileNotFoundError(f"Input file not found: {input_path}")
+
+    # Detect source format
+    source_format, file_type = detect_file_format(input_path)
+
+    if file_type is None:
+        raise ConversionError(f"Cannot determine file type for: {input_path}")
+
+    # Normalize target format to enum
+    if isinstance(target_format, str):
+        target_format = FileFormat(target_format)
+    elif target_format is None:
+        # Auto-determine: opposite of source
+        target_format = (
+            FileFormat.JSON
+            if source_format == FileFormat.COMPASS
+            else FileFormat.COMPASS
+        )
+
+    # Validate: no same-format conversion
+    if source_format == target_format:
+        raise ConversionError(
+            f"Invalid conversion: {source_format.value} => {target_format.value}. "
+            f"Source and target formats must be different."
+        )
+
+    # Perform conversion
+    if source_format == FileFormat.COMPASS and target_format == FileFormat.JSON:
+        # Compass -> JSON using Pydantic
+        if file_type == CompassFileType.DAT:
+            trips = read_dat_file(input_path)
+            dat_file = CompassDatFile(trips=trips)
+            # Wrap in format envelope for DAT files
+            envelope = {
+                "version": "1.0",
+                "format": FormatIdentifier.COMPASS_DAT.value,
+                "trips": json.loads(dat_file.model_dump_json(by_alias=True))["trips"],
+            }
+            result = json.dumps(envelope, indent=2, sort_keys=True)
+        else:  # mak
+            project = load_project(input_path)
+            result = project.model_dump_json(indent=2, by_alias=True)
+
+    elif source_format == FileFormat.JSON and target_format == FileFormat.COMPASS:
+        # JSON -> Compass using Pydantic
+        json_str = input_path.read_text(encoding=JSON_ENCODING)
+        if file_type == CompassFileType.DAT:
+            data = json.loads(json_str)
+            # Handle both envelope format and raw format
+            trips_data = data.get("trips", [])
+            dat_file = CompassDatFile.model_validate({"trips": trips_data})
+            result = format_dat_file(dat_file.trips) or ""
+        else:  # mak
+            project = CompassMakFile.model_validate_json(json_str)
+            result = format_mak_file(project.directives) or ""
+
+    else:
+        raise ConversionError(
+            f"Unsupported conversion: {source_format.value} => {target_format.value}"
+        )
+
+    # Output handling
+    if output_path is None:
+        return result
+
+    # Write to file
+    if target_format == FileFormat.JSON:
+        output_path.write_text(result, encoding=JSON_ENCODING)
+    else:
+        # Compass format uses Windows-1252
+        output_path.write_text(result, encoding=COMPASS_ENCODING, errors="replace")
+
+    return None
 
 
 def convert(args: list[str]) -> int:
-    parser = argparse.ArgumentParser(prog="compass convert")
+    """Entry point for the convert command."""
+    parser = argparse.ArgumentParser(
+        prog="compass convert",
+        description="Convert Compass files between native and JSON formats",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""
+Examples:
+  compass convert -i survey.DAT                     # Convert to JSON (stdout)
+  compass convert -i survey.DAT -o survey.json      # Convert to JSON file
+  compass convert -i project.MAK -f json            # Convert to JSON (stdout)
+  compass convert -i survey.json -o survey.DAT      # Convert to Compass format
+  compass convert -i survey.json -f compass         # Convert to Compass (stdout)
+
+Supported conversions:
+  compass -> json    Survey/project data to JSON
+  json -> compass    JSON to survey/project data
+
+Notes:
+  - File type (DAT/MAK) is auto-detected from extension or JSON content
+  - Target format is auto-detected if not specified (opposite of source)
+  - Cannot convert compass -> compass or json -> json
+""",
+    )
 
     parser.add_argument(
         "-i",
-        "--input_file",
-        type=str,
-        default=None,
+        "--input-file",
+        type=Path,
         required=True,
-        help="Compass Survey Source File.",
+        help="Input file path (.DAT, .MAK, or .json)",
     )
-
     parser.add_argument(
         "-o",
-        "--output_file",
-        type=str,
+        "--output-file",
+        type=Path,
         default=None,
-        required=True,
-        help="Path to save the converted file at.",
-    )
-
-    parser.add_argument(
-        "-w",
-        "--overwrite",
-        action="store_true",
-        help="Allow overwrite an already existing file.",
-        default=False,
+        help="Output file path (prints to stdout if not specified)",
     )
-
     parser.add_argument(
         "-f",
         "--format",
-        type=str,
-        choices=["json"],
-        required=True,
-        help="Conversion format used.",
+        choices=[FileFormat.COMPASS.value, FileFormat.JSON.value],
+        default=None,
+        dest="target_format",
+        help="Target format: 'compass' or 'json' (auto-detected if not specified)",
     )
 
     parsed_args = parser.parse_args(args)
 
-    dmp_file = Path(parsed_args.input_file)
-    if not dmp_file.exists():
-        raise FileNotFoundError(f"Impossible to find: `{dmp_file}`.")
-
-    output_file = Path(parsed_args.output_file)
-    if output_file.exists() and not parsed_args.overwrite:
-        raise FileExistsError(
-            f"The file {output_file} already existing. "
-            "Please pass the flag `--overwrite` to ignore."
+    try:
+        result = _convert(
+            input_path=parsed_args.input_file,
+            output_path=parsed_args.output_file,
+            target_format=parsed_args.target_format,
         )
 
-    survey = CompassParser.load_dat_file(dmp_file)
-    survey.to_json(filepath=output_file)
+        if result is not None:
+            # Print to stdout
+            pass
+
+        # Print status to stderr if writing to file
+        if parsed_args.output_file is not None:
+            source_format, _file_type = detect_file_format(parsed_args.input_file)
+            (
+                FileFormat(parsed_args.target_format)
+                if parsed_args.target_format
+                else (
+                    FileFormat.JSON
+                    if source_format == FileFormat.COMPASS
+                    else FileFormat.COMPASS
+                )
+            )
+
+    except ConversionError:
+        return 1
+    except FileNotFoundError:
+        return 1
+    except Exception:  # noqa: BLE001
+        return 1
+
     return 0

compass_lib/commands/encrypt.py

@@ -1,11 +1,13 @@
 from __future__ import annotations
 
 import argparse
+import base64
 import logging
+import lzma
 import os
 from pathlib import Path
 
-from cryptography.fernet import Fernet
+from cryptography.hazmat.primitives.ciphers.aead import AESSIV
 from dotenv import load_dotenv
 
 logger = logging.getLogger(__name__)
@@ -39,7 +41,15 @@ def encrypt(args: list[str]) -> int:
         type=str,
         default=None,
         required=True,
-        help="Path of the environment file containing the Fernet key.",
+        help="Path of the environment file containing the AES-SIV key.",
+    )
+
+    parser.add_argument(
+        "-z",
+        "--compress",
+        action="store_true",
+        help="Allow to compress the file before encryption.",
+        default=False,
     )
 
     parser.add_argument(
@@ -68,22 +78,38 @@ def encrypt(args: list[str]) -> int:
     load_dotenv(envfile, verbose=True, override=True)
     logger.info("Loaded environment variables from: `%s`", envfile)
 
-    if (fernet_key := os.getenv("ARTIFACT_ENCRYPTION_KEY")) is None:
+    if (key_str := os.getenv("ARTIFACT_ENCRYPTION_KEY")) is None:
         raise ValueError(
-            "No Fernet key found in the environment file. "
+            "No AES-SIV key found in the environment file. "
             "Check if `ARTIFACT_ENCRYPTION_KEY` is set."
         )
-    fernet_key = Fernet(fernet_key)
+
+    key_bytes = base64.urlsafe_b64decode(key_str.encode("ascii"))
+    aead = AESSIV(key_bytes)
 
     with input_file.open("rb") as f:
         clear_data = f.read()
 
+    # Compress before encryption if requested
+    # LZMA with preset 9 + PRESET_EXTREME for best compression ratio
+    if parsed_args.compress:
+        lzma_filters = [{"id": lzma.FILTER_LZMA2, "preset": 9 | lzma.PRESET_EXTREME}]
+        data_to_encrypt = lzma.compress(
+            clear_data,
+            format=lzma.FORMAT_XZ,
+            filters=lzma_filters,
+        )
+    else:
+        data_to_encrypt = clear_data
+
     with output_file.open("wb") as f:
-        f.write(fernet_key.encrypt(clear_data))
+        f.write(aead.encrypt(data_to_encrypt, None))
 
     # Round Trip Check:
     with output_file.open("rb") as f:
-        roundtrip_data = fernet_key.decrypt(f.read())
+        roundtrip_data = aead.decrypt(f.read(), None)
+        if parsed_args.compress:
+            roundtrip_data = lzma.decompress(roundtrip_data)
         assert clear_data == roundtrip_data
 
     return 0

compass_lib/commands/geojson.py

@@ -0,0 +1,118 @@
+# -*- coding: utf-8 -*-
+"""GeoJSON export command for Compass files.
+
+This command converts Compass MAK+DAT files to GeoJSON format,
+computing station coordinates from the survey data.
+"""
+
+import argparse
+import logging
+from pathlib import Path
+
+from compass_lib.enums import FileExtension
+from compass_lib.geojson import convert_mak_to_geojson
+
+logger = logging.getLogger(__name__)
+
+
+def geojson(args: list[str]) -> int:
+    """Entry point for the geojson command."""
+    parser = argparse.ArgumentParser(
+        prog="compass geojson",
+        description="Convert Compass MAK+DAT files to GeoJSON format",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+        epilog="""
+Examples:
+  compass geojson -i project.MAK                    # Output to stdout
+  compass geojson -i project.MAK -o cave.geojson    # Output to file
+  compass geojson -i project.MAK --no-stations      # Only survey legs
+  compass geojson -i project.MAK --passages         # Include passage polygons
+
+Output:
+  The GeoJSON FeatureCollection includes:
+  - Point features for survey stations
+  - LineString features for survey legs (shots)
+  - Polygon features for passage outlines (optional, from LRUD data)
+
+  Coordinates are in UTM meters, with the CRS specified in the output
+  if the MAK file contains UTM zone information.
+
+Notes:
+  - Station coordinates are computed by traversing shots from fixed points
+  - Fixed points come from link stations with coordinates or project location
+  - If no fixed points exist, the first station is placed at origin (0,0,0)
+  - All coordinates are converted to meters
+""",
+    )
+
+    parser.add_argument(
+        "-i",
+        "--input-file",
+        type=Path,
+        required=True,
+        help="Input MAK file path",
+    )
+    parser.add_argument(
+        "-o",
+        "--output-file",
+        type=Path,
+        default=None,
+        help="Output GeoJSON file path (prints to stdout if not specified)",
+    )
+    parser.add_argument(
+        "--no-stations",
+        action="store_true",
+        help="Exclude station point features",
+    )
+    parser.add_argument(
+        "--no-legs",
+        action="store_true",
+        help="Exclude survey leg features",
+    )
+    parser.add_argument(
+        "--passages",
+        action="store_true",
+        help="Include passage polygon features (from LRUD data)",
+    )
+
+    parsed_args = parser.parse_args(args)
+
+    # Validate input
+    if not parsed_args.input_file.exists():
+        logger.error("Error: Input file not found: %s", parsed_args.input_file)
+        return 1
+
+    if parsed_args.input_file.suffix.lower() != FileExtension.MAK.value:
+        logger.error(
+            "Error: Input file must be a .MAK file: %s", parsed_args.input_file
+        )
+        return 1
+
+    try:
+        result = convert_mak_to_geojson(
+            parsed_args.input_file,
+            output_path=parsed_args.output_file,
+            include_stations=not parsed_args.no_stations,
+            include_legs=not parsed_args.no_legs,
+            include_passages=parsed_args.passages,
+        )
+
+        if parsed_args.output_file is None:
+            # Print to stdout
+            print(result)  # noqa: T201
+
+        else:
+            # Print status to stderr
+            logger.info(
+                "Converted %s -> %s", parsed_args.input_file, parsed_args.output_file
+            )
+
+    except FileNotFoundError:
+        logger.exception("FileNotFoundError")
+        return 1
+
+    except Exception:
+        logger.exception("Unknown Problem ...")
+        return 1
+
+    return 0

compass_lib/commands/main.py

@@ -7,7 +7,7 @@ import compass_lib
 
 
 def main():
-    registered_commands = entry_points(group="compass.actions")
+    registered_commands = entry_points(group="compass_lib.actions")
 
     parser = argparse.ArgumentParser(prog="compass_lib")
     parser.add_argument(