tunas 0.1.0__tar.gz

tunas-0.1.0/.gitignore

@@ -0,0 +1,30 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Test / coverage
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+
+# Type checker / linter caches
+.mypy_cache/
+.ruff_cache/
+
+# Editor / OS
+.DS_Store
+.idea/
+.vscode/
+
+# Agents
+.antigravitycli
+CLAUDE.md
+GEMINI.md

tunas-0.1.0/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to `tunas` will be documented in this file. The format is
+based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this
+project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] — Unreleased
+
+Initial release of the `tunas` library, providing a parser and domain model for USA Swimming `.cl2` (Hy-Tek SDIF v3) files.
+
+### Added
+- **Unified Entry Point:** `read_cl2(source, *, strict=False, encoding="cp1252", errors="replace") -> tuple[list[Meet], ParseReport]` accepts paths, directories, lists, or file-like objects.
+- **Spec Coverage:** Parses every meet-results record type (`A0`–`G0`, `Z0`); qualifying-time records (`J0`–`J2`) surface as warnings.
+- **Domain Model:** Dataclass graph covering `Meet`, `Club`, `Swimmer`, and the swim/result hierarchy (`Swim` → `IndividualSwim`, `RelaySwim`; `MeetResult` → `IndividualSwim`, `Relay`), as well as `Split`, `SwimmerContact`, `SwimmerRegistration`, `MeetHost`, `SourceFile`, `Time`, and `Event`. Swimmers expose a unified `swims` list.
+- **Pure and Faithful Parsing:** Meets are self-contained. Swimmers are unified within a meet by member ID (`id_short`, falling back to `id_long`).
+- **Zero Data Loss:** All entered swims are kept, including non-time outcomes (scratches, DQs, no-shows tracked via `ResultStatus`). Missing optional fields are set to `None`. Raw line contents are preserved on validation failures.
+- **Structured Error Model:** Structural (M1) violations raise `ParseError`. Data quality (M2) violations emit warnings or raise in `strict` mode. `ParseReport` provides query helpers (`by_severity`, `warnings_for`) and aggregates counts.
+- **Time Standards:** Offline lookup helpers (`qualifies_for`, `standard_time`, `all_qualified`) using bundled 2025–2028 motivational standards.
+- **Type-hinted:** Fully type-hinted and marked `py.typed`.
+

tunas-0.1.0/LICENSE

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

tunas-0.1.0/PKG-INFO

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: tunas
+Version: 0.1.0
+Summary: USA Swimming meet result (.cl2 / SDIF v3) parser and analysis library
+Project-URL: Homepage, https://github.com/ajoe2/tunas
+Project-URL: Documentation, https://github.com/ajoe2/tunas/tree/main/docs
+Project-URL: Repository, https://github.com/ajoe2/tunas
+Project-URL: Issues, https://github.com/ajoe2/tunas/issues
+Project-URL: Changelog, https://github.com/ajoe2/tunas/blob/main/CHANGELOG.md
+Author-email: Andy Joe <ajoe2468@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cl2,hy-tek,sdif,swim-meet,swimming,usa-swimming
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# tunas
+
+[![PyPI](https://img.shields.io/pypi/v/tunas.svg)](https://pypi.org/project/tunas/)
+[![Python](https://img.shields.io/pypi/pyversions/tunas.svg)](https://pypi.org/project/tunas/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+A Python library for parsing and analyzing USA Swimming meet result files (`.cl2` / Hy-Tek SDIF v3).
+
+`tunas` parses `.cl2` files into clean, idiomatic Python objects (`Meet`, `Club`, `Swimmer`, `IndividualSwim`, `Relay`) and bundles USA Swimming time standards for offline qualifying-time lookups.
+
+## Install
+
+```
+pip install tunas
+```
+
+Requires Python 3.12+ and has zero third-party runtime dependencies.
+
+## Quick example
+
+```python
+from tunas import read_cl2
+
+meets, report = read_cl2("results.cl2")
+
+for meet in meets:
+    print(f"{meet.name} ({meet.start_date})")
+    for swim in meet.individual_swims:
+        outcome = swim.time if swim.time is not None else swim.status.value  # DQ / NS / ...
+        print(f"  {swim.swimmer.full_name:<24} {swim.event.name:<16} {outcome}")
+
+if report.warnings:
+    print(f"{len(report.warnings)} records flagged — see report.warnings")
+```
+
+`read_cl2` parses files into self-contained `Meet` objects and a `ParseReport`. Swimmers are scoped to each meet; reconcile cross-meet swimmers by grouping on `id_short` or `id_long` in your application.
+
+## Features
+
+- **SDIF v3 Parser:** Parses `.cl2` meet result files including relays (E0/F0) and splits (G0).
+- **Self-Contained Meets:** No global state or cross-file merging; parsing is a pure function of input bytes.
+- **Clean Object Model:** Slotted dataclasses with direct object references (swimmers, clubs, swims, splits, and contact/registration data).
+- **Offline Time Standards:** Local lookup of USA Swimming B through AAAA motivational cuts.
+- **Lenient Parsing:** Recovers from data-quality issues by default with a detailed `ParseReport`. Opt-in `strict=True` raises on the first violation.
+- **Type-Safe:** Fully typed and carries the `py.typed` marker.
+
+## Documentation
+
+Full documentation is available in [`docs/`](docs/):
+
+- [Getting started](docs/getting_started.md)
+- [Architecture](docs/architecture.md)
+- [Parsing](docs/parsing.md) · [Models](docs/models.md) · [Time](docs/time.md) · [Event](docs/event.md) · [Enums](docs/enums.md) · [Exceptions](docs/exceptions.md) · [Standards](docs/standards.md)
+- [CL2 / SDIF v3 format](docs/cl2_format.md) · [Cookbook](docs/cookbook.md)
+
+## Development
+
+Managed with [`uv`](https://docs.astral.sh/uv/) (Python 3.12+):
+
+```bash
+uv sync                     # set up the environment
+uv run pytest               # run the (offline, self-contained) test suite
+uv run pytest --cov=tunas   # with coverage (gated at 95%)
+uv run ruff check && uv run mypy src/tunas   # lint + type-check
+```
+
+See [docs/architecture.md](docs/architecture.md#development) for the full
+workflow and the release process.
+
+## Status
+
+`tunas` is in **alpha**. The API documented in `docs/` is stable, but breaking changes may occur before 1.0 based on real-world feedback.
+
+## License
+
+[MIT](LICENSE)
+
+

tunas-0.1.0/README.md

@@ -0,0 +1,78 @@
+# tunas
+
+[![PyPI](https://img.shields.io/pypi/v/tunas.svg)](https://pypi.org/project/tunas/)
+[![Python](https://img.shields.io/pypi/pyversions/tunas.svg)](https://pypi.org/project/tunas/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+A Python library for parsing and analyzing USA Swimming meet result files (`.cl2` / Hy-Tek SDIF v3).
+
+`tunas` parses `.cl2` files into clean, idiomatic Python objects (`Meet`, `Club`, `Swimmer`, `IndividualSwim`, `Relay`) and bundles USA Swimming time standards for offline qualifying-time lookups.
+
+## Install
+
+```
+pip install tunas
+```
+
+Requires Python 3.12+ and has zero third-party runtime dependencies.
+
+## Quick example
+
+```python
+from tunas import read_cl2
+
+meets, report = read_cl2("results.cl2")
+
+for meet in meets:
+    print(f"{meet.name} ({meet.start_date})")
+    for swim in meet.individual_swims:
+        outcome = swim.time if swim.time is not None else swim.status.value  # DQ / NS / ...
+        print(f"  {swim.swimmer.full_name:<24} {swim.event.name:<16} {outcome}")
+
+if report.warnings:
+    print(f"{len(report.warnings)} records flagged — see report.warnings")
+```
+
+`read_cl2` parses files into self-contained `Meet` objects and a `ParseReport`. Swimmers are scoped to each meet; reconcile cross-meet swimmers by grouping on `id_short` or `id_long` in your application.
+
+## Features
+
+- **SDIF v3 Parser:** Parses `.cl2` meet result files including relays (E0/F0) and splits (G0).
+- **Self-Contained Meets:** No global state or cross-file merging; parsing is a pure function of input bytes.
+- **Clean Object Model:** Slotted dataclasses with direct object references (swimmers, clubs, swims, splits, and contact/registration data).
+- **Offline Time Standards:** Local lookup of USA Swimming B through AAAA motivational cuts.
+- **Lenient Parsing:** Recovers from data-quality issues by default with a detailed `ParseReport`. Opt-in `strict=True` raises on the first violation.
+- **Type-Safe:** Fully typed and carries the `py.typed` marker.
+
+## Documentation
+
+Full documentation is available in [`docs/`](docs/):
+
+- [Getting started](docs/getting_started.md)
+- [Architecture](docs/architecture.md)
+- [Parsing](docs/parsing.md) · [Models](docs/models.md) · [Time](docs/time.md) · [Event](docs/event.md) · [Enums](docs/enums.md) · [Exceptions](docs/exceptions.md) · [Standards](docs/standards.md)
+- [CL2 / SDIF v3 format](docs/cl2_format.md) · [Cookbook](docs/cookbook.md)
+
+## Development
+
+Managed with [`uv`](https://docs.astral.sh/uv/) (Python 3.12+):
+
+```bash
+uv sync                     # set up the environment
+uv run pytest               # run the (offline, self-contained) test suite
+uv run pytest --cov=tunas   # with coverage (gated at 95%)
+uv run ruff check && uv run mypy src/tunas   # lint + type-check
+```
+
+See [docs/architecture.md](docs/architecture.md#development) for the full
+workflow and the release process.
+
+## Status
+
+`tunas` is in **alpha**. The API documented in `docs/` is stable, but breaking changes may occur before 1.0 based on real-world feedback.
+
+## License
+
+[MIT](LICENSE)
+
+

tunas-0.1.0/pyproject.toml

@@ -0,0 +1,90 @@
+[project]
+name = "tunas"
+dynamic = ["version"]
+description = "USA Swimming meet result (.cl2 / SDIF v3) parser and analysis library"
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "Andy Joe", email = "ajoe2468@gmail.com" }]
+keywords = ["swimming", "sdif", "cl2", "hy-tek", "usa-swimming", "swim-meet"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+    "Typing :: Typed",
+]
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/ajoe2/tunas"
+Documentation = "https://github.com/ajoe2/tunas/tree/main/docs"
+Repository = "https://github.com/ajoe2/tunas"
+Issues = "https://github.com/ajoe2/tunas/issues"
+Changelog = "https://github.com/ajoe2/tunas/blob/main/CHANGELOG.md"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "src/tunas/_version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/tunas"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/tunas",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md",
+    "pyproject.toml",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=8",
+    "pytest-cov>=5",
+    "ruff>=0.6",
+    "mypy>=1.11",
+    "openpyxl>=3.1",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra --strict-markers"
+
+[tool.coverage.run]
+source = ["tunas"]
+
+[tool.coverage.report]
+# CI runs `pytest --cov=tunas`; this gates the result.
+fail_under = 95
+show_missing = true
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+src = ["src"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "UP", "SIM"]
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+files = ["src/tunas"]
+
+[tool.pyright]
+# Lets Pylance resolve the project venv (pytest, etc.) and the tests/ helpers
+# (conftest) that pytest puts on sys.path at runtime.
+include = ["src", "tests", "scripts"]
+extraPaths = ["tests"]
+venvPath = "."
+venv = ".venv"
+pythonVersion = "3.12"

tunas-0.1.0/src/tunas/__init__.py

@@ -0,0 +1,110 @@
+"""tunas — USA Swimming meet result (.cl2 / SDIF v3) parser library.
+
+Parses Hy-Tek SDIF v3 ``.cl2`` files into a clean, well-typed domain model and
+bundles USA Swimming motivational time standards for offline lookups.
+"""
+
+from __future__ import annotations
+
+from tunas._version import __version__
+from tunas.enums import (
+    Affiliation,
+    AttachStatus,
+    Citizenship,
+    Course,
+    Ethnicity,
+    EventTimeClass,
+    FileType,
+    MeetType,
+    MemberStatus,
+    Organization,
+    Region,
+    RelayLegOrder,
+    ResultStatus,
+    Season,
+    Session,
+    Sex,
+    SplitType,
+    Stroke,
+)
+from tunas.event import Event
+from tunas.exceptions import ParseError, StandardsError, TunasError
+from tunas.geography import LSC, Country, State
+from tunas.models import (
+    Club,
+    ClubEntryCounts,
+    IndividualSwim,
+    Meet,
+    MeetHost,
+    MeetResult,
+    Relay,
+    RelaySwim,
+    SourceFile,
+    Split,
+    Swim,
+    Swimmer,
+    SwimmerContact,
+    SwimmerRegistration,
+)
+from tunas.parser import IssueKind, ParseReport, ParseWarning, Severity, read_cl2
+from tunas.standards import TimeStandard, all_qualified, qualifies_for, standard_time
+from tunas.time import Time
+
+__all__ = [
+    "__version__",
+    # parsing
+    "read_cl2",
+    "ParseReport",
+    "ParseWarning",
+    "Severity",
+    "IssueKind",
+    # exceptions
+    "TunasError",
+    "ParseError",
+    "StandardsError",
+    # models
+    "Meet",
+    "Club",
+    "Swimmer",
+    "Swim",
+    "MeetResult",
+    "IndividualSwim",
+    "Relay",
+    "RelaySwim",
+    "Split",
+    "SwimmerContact",
+    "SwimmerRegistration",
+    "MeetHost",
+    "SourceFile",
+    "ClubEntryCounts",
+    # value types
+    "Time",
+    "Event",
+    # enums
+    "Sex",
+    "Stroke",
+    "Course",
+    "Session",
+    "AttachStatus",
+    "MeetType",
+    "Region",
+    "EventTimeClass",
+    "Organization",
+    "FileType",
+    "SplitType",
+    "ResultStatus",
+    "RelayLegOrder",
+    "MemberStatus",
+    "Season",
+    "Ethnicity",
+    "Affiliation",
+    "Citizenship",
+    "LSC",
+    "State",
+    "Country",
+    # standards
+    "TimeStandard",
+    "qualifies_for",
+    "standard_time",
+    "all_qualified",
+]