pyxctsk 0.1.0__tar.gz

pyxctsk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 pyxctsk Contributors
+
+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.

pyxctsk-0.1.0/PKG-INFO

@@ -0,0 +1,260 @@
+Metadata-Version: 2.1
+Name: pyxctsk
+Version: 0.1.0
+Summary: Python implementation of XCTrack's task format
+Author-email: Simon Steiner <simonsteiner@users.noreply.github.com>
+License: MIT
+Project-URL: Homepage, https://github.com/simonsteiner/pyxctsk
+Project-URL: Repository, https://github.com/simonsteiner/pyxctsk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0.0
+Requires-Dist: geopy>=2.0.0
+Requires-Dist: Pillow>=8.0.0
+Requires-Dist: polyline>=2.0.0
+Requires-Dist: pyproj>=3.0.0
+Requires-Dist: pyzbar>=0.1.9
+Requires-Dist: qrcode[pil]>=7.0.0
+Provides-Extra: dev
+Requires-Dist: beautifulsoup4>=4.9.0; extra == "dev"
+Requires-Dist: black>=21.0.0; extra == "dev"
+Requires-Dist: flake8>=3.8.0; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Requires-Dist: mypy>=0.800; extra == "dev"
+Requires-Dist: pytest-cov>=2.0.0; extra == "dev"
+Requires-Dist: pytest>=6.0.0; extra == "dev"
+Requires-Dist: requests>=2.25.0; extra == "dev"
+
+# pyxctsk - Python implementation of XCTrack's task format
+
+A comprehensive Python ecosystem for parsing, analyzing, and visualizing XCTrack task files and formats.
+
+This repository contains the core module:
+
+- **`xctrack`** - Core library for parsing and manipulating XCTrack task files
+
+## Modules Overview
+
+### pyxctsk Core (`src/pyxctsk/`)
+
+The core Python library providing:
+
+- Reading and writing `.xctsk` task files (JSON format)
+- Generating and parsing `XCTSK:` URLs for task sharing
+- Creating and decoding QR codes containing task data
+- Converting tasks to KML format for visualization
+- Command-line interface for format conversion
+
+## Installation
+
+### Core Library Only
+
+```bash
+pip install pyxctsk
+```
+
+### Development Installation
+
+#### Setting up Virtual Environment
+
+```bash
+git clone https://github.com/simonsteiner/pyxctsk.git
+cd pyxctsk
+
+# Create and activate virtual environment
+python3 -m venv venv
+source venv/bin/activate
+# in subfolder use this command
+source /home/simon/git/pyxctsk/venv/bin/activate
+
+# Install core library in development mode with dev dependencies
+pip install -e ".[dev]"
+```
+
+#### Development Workflow
+
+Once your virtual environment is set up:
+
+```bash
+# Format code before committing
+black src/ tests/
+isort src/ tests/
+
+# Run linting
+flake8 src/ tests/
+
+# Run type checking
+mypy src/
+
+# Run tests
+pytest
+
+# Deactivate when done
+deactivate
+```
+
+#### Verification
+
+```bash
+# Test that pyxctsk is properly installed
+pyxctsk --help
+
+# Run tests to ensure everything works
+pytest
+
+# Check code quality tools are available
+black --version
+isort --version
+flake8 --version
+mypy --version
+```
+
+## Quick Start
+
+### Core Library Usage
+
+```python
+from pyxctsk import parse_task
+
+# From file
+task = parse_task('my_task.xctsk')
+
+# From XCTSK: URL
+task = parse_task('XCTSK:{"version":1,"taskType":"CLASSIC",...}')
+
+# From QR code image (requires pyzbar and PIL)
+task = parse_task('qr_code.png')
+
+print(f"Task type: {task.task_type}")
+print(f"Number of turnpoints: {len(task.turnpoints)}")
+```
+
+### Command Line Tools
+
+Core XCTrack CLI:
+
+```bash
+# Convert task file to JSON
+pyxctsk convert task.xctsk --format json
+
+# Generate QR code
+pyxctsk convert task.xctsk --format png --output qr.png
+```
+
+### Creating a task
+
+```python
+from pyxctsk import Task, TaskType, Turnpoint, Waypoint
+
+task = Task(
+    task_type=TaskType.CLASSIC,
+    version=1,
+    turnpoints=[
+        Turnpoint(
+            radius=1000,
+            waypoint=Waypoint(
+                name="TP01",
+                lat=46.5,
+                lon=8.0,
+                alt_smoothed=1000
+            )
+        )
+    ]
+)
+
+# Save as JSON
+with open('task.xctsk', 'w') as f:
+    f.write(task.to_json())
+```
+
+### QR Code Generation
+
+```python
+from pyxctsk.utils import generate_qr_code
+
+# Convert task to QR code format and generate image
+qr_task = task.to_qr_code_task()
+qr_string = qr_task.to_string()
+qr_image = generate_qr_code(qr_string)
+qr_image.save('task_qr.png')
+```
+
+### KML Export
+
+```python
+from pyxctsk.utils import task_to_kml
+
+kml_content = task_to_kml(task)
+with open('task.kml', 'w') as f:
+    f.write(kml_content)
+```
+
+## Command Line Interface
+
+The package includes a command-line tool for format conversion:
+
+```bash
+# Convert task to different formats
+python -m pyxctsk task.xctsk --format json        # JSON output
+python -m pyxctsk task.xctsk --format kml         # KML output  
+python -m pyxctsk task.xctsk --format qrcode-json # XCTSK: URL
+python -m pyxctsk task.xctsk --format png -o qr.png # QR code image
+
+# Parse from different inputs
+python -m pyxctsk qr_code.png --format json       # From QR image
+cat task.xctsk | python -m pyxctsk --format kml   # From stdin
+```
+
+## Requirements
+
+- Python 3.8+
+- Click (for CLI)
+- Optional QR code support:
+  - Pillow (PIL) for image generation
+  - qrcode for QR code generation  
+  - pyzbar for QR code reading from images
+
+## Data Structures
+
+The library provides comprehensive data classes for XCTrack task components:
+
+- `Task`: Main task container
+- `Turnpoint`: Individual waypoints with radius and type information
+- `Waypoint`: Geographic coordinates and metadata
+- `SSS`: Start of speed section configuration
+- `Goal`: Goal/finish line configuration  
+- `Takeoff`: Takeoff location
+- `TimeOfDay`: Time representation with validation
+
+All classes support JSON serialization/deserialization and maintain compatibility with the XCTrack file format.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## AI-Assisted Migration
+
+This Python implementation was migrated from the original Go codebase with the assistance of GitHub Copilot. The migration process involved:
+
+- **AI Model**: Claude 4 Sonnet (via GitHub Copilot Chat)
+- **Migration Approach**: Automated code analysis and conversion with human oversight
+- **Process**: Complete rewrite maintaining API compatibility and feature parity
+- **Validation**: Comprehensive testing against XCTrack Competition Interfaces specification
+- **Quality Assurance**: Manual verification of all core functionality and edge cases
+
+The AI assistant analyzed the Go source code structure, understood the XCTrack protocol specifications, and generated equivalent Python implementations while ensuring compatibility with the original format and adding modern Python idioms and type hints.
+
+## Original Go Implementation
+
+This Python library is based on the Go implementation by Tom Payne:
+<https://github.com/twpayne/go-xctrack>

pyxctsk-0.1.0/README.md

@@ -0,0 +1,223 @@
+# pyxctsk - Python implementation of XCTrack's task format
+
+A comprehensive Python ecosystem for parsing, analyzing, and visualizing XCTrack task files and formats.
+
+This repository contains the core module:
+
+- **`xctrack`** - Core library for parsing and manipulating XCTrack task files
+
+## Modules Overview
+
+### pyxctsk Core (`src/pyxctsk/`)
+
+The core Python library providing:
+
+- Reading and writing `.xctsk` task files (JSON format)
+- Generating and parsing `XCTSK:` URLs for task sharing
+- Creating and decoding QR codes containing task data
+- Converting tasks to KML format for visualization
+- Command-line interface for format conversion
+
+## Installation
+
+### Core Library Only
+
+```bash
+pip install pyxctsk
+```
+
+### Development Installation
+
+#### Setting up Virtual Environment
+
+```bash
+git clone https://github.com/simonsteiner/pyxctsk.git
+cd pyxctsk
+
+# Create and activate virtual environment
+python3 -m venv venv
+source venv/bin/activate
+# in subfolder use this command
+source /home/simon/git/pyxctsk/venv/bin/activate
+
+# Install core library in development mode with dev dependencies
+pip install -e ".[dev]"
+```
+
+#### Development Workflow
+
+Once your virtual environment is set up:
+
+```bash
+# Format code before committing
+black src/ tests/
+isort src/ tests/
+
+# Run linting
+flake8 src/ tests/
+
+# Run type checking
+mypy src/
+
+# Run tests
+pytest
+
+# Deactivate when done
+deactivate
+```
+
+#### Verification
+
+```bash
+# Test that pyxctsk is properly installed
+pyxctsk --help
+
+# Run tests to ensure everything works
+pytest
+
+# Check code quality tools are available
+black --version
+isort --version
+flake8 --version
+mypy --version
+```
+
+## Quick Start
+
+### Core Library Usage
+
+```python
+from pyxctsk import parse_task
+
+# From file
+task = parse_task('my_task.xctsk')
+
+# From XCTSK: URL
+task = parse_task('XCTSK:{"version":1,"taskType":"CLASSIC",...}')
+
+# From QR code image (requires pyzbar and PIL)
+task = parse_task('qr_code.png')
+
+print(f"Task type: {task.task_type}")
+print(f"Number of turnpoints: {len(task.turnpoints)}")
+```
+
+### Command Line Tools
+
+Core XCTrack CLI:
+
+```bash
+# Convert task file to JSON
+pyxctsk convert task.xctsk --format json
+
+# Generate QR code
+pyxctsk convert task.xctsk --format png --output qr.png
+```
+
+### Creating a task
+
+```python
+from pyxctsk import Task, TaskType, Turnpoint, Waypoint
+
+task = Task(
+    task_type=TaskType.CLASSIC,
+    version=1,
+    turnpoints=[
+        Turnpoint(
+            radius=1000,
+            waypoint=Waypoint(
+                name="TP01",
+                lat=46.5,
+                lon=8.0,
+                alt_smoothed=1000
+            )
+        )
+    ]
+)
+
+# Save as JSON
+with open('task.xctsk', 'w') as f:
+    f.write(task.to_json())
+```
+
+### QR Code Generation
+
+```python
+from pyxctsk.utils import generate_qr_code
+
+# Convert task to QR code format and generate image
+qr_task = task.to_qr_code_task()
+qr_string = qr_task.to_string()
+qr_image = generate_qr_code(qr_string)
+qr_image.save('task_qr.png')
+```
+
+### KML Export
+
+```python
+from pyxctsk.utils import task_to_kml
+
+kml_content = task_to_kml(task)
+with open('task.kml', 'w') as f:
+    f.write(kml_content)
+```
+
+## Command Line Interface
+
+The package includes a command-line tool for format conversion:
+
+```bash
+# Convert task to different formats
+python -m pyxctsk task.xctsk --format json        # JSON output
+python -m pyxctsk task.xctsk --format kml         # KML output  
+python -m pyxctsk task.xctsk --format qrcode-json # XCTSK: URL
+python -m pyxctsk task.xctsk --format png -o qr.png # QR code image
+
+# Parse from different inputs
+python -m pyxctsk qr_code.png --format json       # From QR image
+cat task.xctsk | python -m pyxctsk --format kml   # From stdin
+```
+
+## Requirements
+
+- Python 3.8+
+- Click (for CLI)
+- Optional QR code support:
+  - Pillow (PIL) for image generation
+  - qrcode for QR code generation  
+  - pyzbar for QR code reading from images
+
+## Data Structures
+
+The library provides comprehensive data classes for XCTrack task components:
+
+- `Task`: Main task container
+- `Turnpoint`: Individual waypoints with radius and type information
+- `Waypoint`: Geographic coordinates and metadata
+- `SSS`: Start of speed section configuration
+- `Goal`: Goal/finish line configuration  
+- `Takeoff`: Takeoff location
+- `TimeOfDay`: Time representation with validation
+
+All classes support JSON serialization/deserialization and maintain compatibility with the XCTrack file format.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## AI-Assisted Migration
+
+This Python implementation was migrated from the original Go codebase with the assistance of GitHub Copilot. The migration process involved:
+
+- **AI Model**: Claude 4 Sonnet (via GitHub Copilot Chat)
+- **Migration Approach**: Automated code analysis and conversion with human oversight
+- **Process**: Complete rewrite maintaining API compatibility and feature parity
+- **Validation**: Comprehensive testing against XCTrack Competition Interfaces specification
+- **Quality Assurance**: Manual verification of all core functionality and edge cases
+
+The AI assistant analyzed the Go source code structure, understood the XCTrack protocol specifications, and generated equivalent Python implementations while ensuring compatibility with the original format and adding modern Python idioms and type hints.
+
+## Original Go Implementation
+
+This Python library is based on the Go implementation by Tom Payne:
+<https://github.com/twpayne/go-xctrack>

pyxctsk-0.1.0/pyproject.toml

@@ -0,0 +1,81 @@
+[build-system]
+requires = ["setuptools>=45", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyxctsk"
+version = "0.1.0"
+description = "Python implementation of XCTrack's task format"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "Simon Steiner", email = "simonsteiner@users.noreply.github.com"}
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "click>=8.0.0",
+    "geopy>=2.0.0",
+    "Pillow>=8.0.0",
+    "polyline>=2.0.0",
+    "pyproj>=3.0.0",
+    "pyzbar>=0.1.9",
+    "qrcode[pil]>=7.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "beautifulsoup4>=4.9.0",
+    "black>=21.0.0",
+    "flake8>=3.8.0",
+    "isort>=5.0.0",
+    "mypy>=0.800",
+    "pytest-cov>=2.0.0",
+    "pytest>=6.0.0",
+    "requests>=2.25.0",
+]
+
+[project.scripts]
+pyxctsk = "pyxctsk.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/simonsteiner/pyxctsk"
+Repository = "https://github.com/simonsteiner/pyxctsk"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-dir]
+"" = "src"
+
+[tool.black]
+line-length = 88
+target-version = ['py38']
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+
+[tool.mypy]
+python_version = "3.8"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "-ra -q"
+testpaths = ["tests"]
+markers = [
+    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
+]

pyxctsk-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pyxctsk-0.1.0/src/pyxctsk/__init__.py

@@ -0,0 +1,73 @@
+"""
+pyxctsk - Python implementation of XCTrack's task format.
+
+This package implements XCTrack's task format for reading and writing .xctsk files,
+generating and parsing XCTSK: URLs, and encoding/decoding XCTSK: URLs as QR codes.
+
+See http://xctrack.org/ and http://xctrack.org/Competition_Interfaces.html
+"""
+
+from .distance import (
+    TaskTurnpoint,
+    calculate_task_distances,
+    distance_through_centers,
+    optimized_distance,
+)
+from .exceptions import (
+    EmptyInputError,
+    InvalidFormatError,
+    InvalidTimeOfDayError,
+)
+from .geojson import generate_task_geojson
+from .parser import parse_task
+from .qrcode_task import QRCodeTask
+from .task import (
+    SSS,
+    Direction,
+    EarthModel,
+    Goal,
+    GoalType,
+    SSSType,
+    Takeoff,
+    Task,
+    TaskType,
+    TimeOfDay,
+    Turnpoint,
+    TurnpointType,
+    Waypoint,
+)
+
+# Constants
+EXTENSION = ".xctsk"
+MIME_TYPE = "application/xctsk"
+VERSION = 1
+
+__version__ = "1.0.0"
+__all__ = [
+    "Task",
+    "Takeoff",
+    "SSS",
+    "Goal",
+    "Turnpoint",
+    "Waypoint",
+    "TimeOfDay",
+    "Direction",
+    "EarthModel",
+    "GoalType",
+    "SSSType",
+    "TaskType",
+    "TurnpointType",
+    "generate_task_geojson",
+    "QRCodeTask",
+    "parse_task",
+    "calculate_task_distances",
+    "optimized_distance",
+    "distance_through_centers",
+    "TaskTurnpoint",
+    "EmptyInputError",
+    "InvalidFormatError",
+    "InvalidTimeOfDayError",
+    "EXTENSION",
+    "MIME_TYPE",
+    "VERSION",
+]

pyxctsk-0.1.0/src/pyxctsk/__main__.py

@@ -0,0 +1,6 @@
+"""Entry point for running pyxctsk as a module."""
+
+from .cli import main
+
+if __name__ == "__main__":
+    main()