Skip to main content

Validate and clean Two-Line Element (TLE) satellite-tracking files

Project description

lintle

A validator and cleaner for Two-Line Element (TLE) corpus files exported from space-track.org.

It audits a TLE file against the standardized TLE specification, repairs the systematic export defects, and emits a uniform, de-defected corpus that any SGP4 / orbital-mechanics library can ingest directly. Records it cannot safely repair are quarantined — never silently mangled — into a per-file sidecar detailed enough to file a defect report with space-track.


What problem it solves

A TLE record is two fixed-width lines, each exactly 69 ASCII columns, with a mod-10 checksum in column 69. Bulk historical exports from space-track carry two systematic, era-specific defects:

  • Trailing \ artifact — almost every Line 1 has an extra \ byte appended before the newline.
  • Missing checksum digit — many records were exported without their column-69 checksum, leaving 68-column lines.

These appear independently and in combination, and a small fraction of records are genuinely corrupt (garbled columns, orphaned lines, wrong lengths). lintle distinguishes the safely-repairable from the genuinely-corrupt and treats each correctly.

How it works

One validator, used two ways. A single module (tle.py) defines what a "perfect" TLE record is — column layout, semantic ranges, and the mod-10 checksum. The validate command reports defects against that definition; the clean command reuses the exact same validator and only emits records that pass it.

The validated-transformation principle. The cleaner never applies a fix and hopes. It applies a candidate fix, then re-runs full validation on the result, and commits the fix only if it now passes. Consequently the cleaner cannot turn a bad record into a wrong-but-valid-looking one, and every line in the output is valid by construction.

Five fix classes, in decreasing order of safety:

Class Examples Action
Content-preserving trailing \, CRLF, trailing whitespace auto-fix (checksum survives as an independent check)
Reconstructed-checksum a record exported without its column-69 digit recompute the checksum from intact columns 1–68
Content-shifting leading whitespace / BOM trim, then re-validate; quarantine if it fails
Structural blank / whitespace-only lines drop, resynchronise pairing
Corrupt bad checksum, wrong length, orphan line, garbled columns quarantine

Streaming and parallel. Files are read in binary, line by line, in constant memory — a 3 GB file never loads into RAM. Records are paired by a prefix-driven state machine that resynchronises on every 1 line, so one missing line cannot cascade into mispaired records. Each input file is processed in its own worker process.

Requirements

  • Python 3.11+
  • uv for environment and dependency management

lintle itself has no runtime dependencies — it is pure standard library. sgp4 is a dev-only dependency, used as a test oracle.

Installation

uv sync

This creates the virtual environment and installs the dev dependencies. No build step is needed to run the tool.

Usage

The console script is lintle:

# Audit only — report defects, write nothing
uv run lintle validate [paths...]

# Produce cleaned output + quarantine sidecars
uv run lintle clean [paths...]

# Explain a rule ID or fix tag — definition, examples, source citation
uv run lintle explain <TAG>

python -m lintle ... is equivalent to uv run lintle ....

Arguments and options:

Option Default Meaning
paths data/source Files or directories. A directory is globbed for tle*.txt (tool output *.cleaned.txt / *.broken.txt is excluded).
--out-dir DIR data/output Where clean writes its output. Created if absent.
--jobs N CPU count Number of files processed in parallel. Lower it if a slow disk causes I/O contention.
--report text|json text Summary format.
--max-quarantined N 0 Exit non-zero only if MORE than N records were quarantined. Default 0 ≡ "any quarantine fails".
--resume off (clean only) Continue an interrupted run in --out-dir: skip files already completed and process only the rest. Refuses if the lintle version or any input changed since the interrupted run.

Examples:

# Validate the whole corpus
uv run lintle validate data/source

# Clean one file
uv run lintle clean data/source/tle2022.txt --out-dir data/output

# Clean the corpus, capture a machine-readable summary
uv run lintle clean data/source --report json > run-summary.json

# CI gate: tolerate up to 100 quarantined records before failing the job
uv run lintle clean data/source --max-quarantined 100 --report json > run-summary.json

# Look up what a rule ID or fix tag means, with a verified example
uv run lintle explain TLE-CHK-001
uv run lintle explain reconstructed-checksum

# Resume an interrupted run (e.g. the laptop slept mid-corpus) — finish only what's left
uv run lintle clean data/source --out-dir data/output --resume

Exit codes:

Code Meaning
0 Total quarantined is at or below --max-quarantined (default 0).
1 More than --max-quarantined records were quarantined.
2 Operational error — no input files, disk shortfall, or a file that failed to process.

Repairable defects (including the near-universal trailing \) do not raise the exit code above 0 — almost every raw file contains them. --max-quarantined preserves the meaningful 2 (operational error) and 130 (Ctrl-C) signals that a lintle ... || true pipe would swallow.

Resuming an interrupted run

A long clean over the full corpus can be interrupted — Ctrl-C, a closed laptop, a crash. Re-run the same command with --resume to finish it: files already completed are skipped (their cleaned/, broken/, and report contributions reused) and only the remainder is processed.

While a run is in flight it maintains a small .clean-state.json checkpoint in --out-dir, deleted on successful completion — so its presence marks an interrupted run, and a finished run leaves none behind. --resume refuses (exit 2) if the lintle version or any input file changed since the interruption, rather than silently mixing outputs from two different states; re-run without --resume for a clean full pass. This is single-run resume, not a cross-run cache: each run still re-validates every record it emits.

Output

A clean run lays --out-dir out like this:

<out-dir>/
├── cleaned/                tleYYYY.cleaned.txt   — one per input file
├── broken/                 tleYYYY.broken.txt    — one per input file
├── broken-noradids.ndjson  — corpus-wide list of quarantined NORAD IDs
└── report.md               — corpus-wide run report
  • cleaned/tleYYYY.cleaned.txt — standard 2-line TLE text, every record verified valid: 69 ASCII columns per line, \n-terminated, matching satellite catalog numbers, valid checksums. World-readable, ready for downstream ingestion.

  • broken/tleYYYY.broken.txt — the quarantine sidecar. Each entry records the source line number(s), a human-readable reason, and the offending line(s) copied byte-faithfully. The header carries totals, a timestamp, and the tool version — formatted to paste into a space-track defect report.

  • broken-noradids.ndjson — newline-delimited JSON, one {"noradId":N} object per line, listing every NORAD catalog number whose records were quarantined anywhere in the run, deduplicated and sorted ascending. Records whose line 1 is itself unreadable are omitted — there's no catalog number to recover. Intended for programmatic downstream consumers (e.g. a satellite catalog flagging archive gaps) that want the affected IDs without parsing broken/*.txt. The schema is deliberately minimal; future releases may extend each record with additional fields, which consumers can ignore safely. Empty file when nothing was quarantined.

  • report.md — a Markdown run report aggregating the whole run: corpus totals, the percentage cleaned and quarantined, corpus-wide fix counts, the defect-rule breakdown (keyed by stable RuleID tokens like TLE-CHK-001), a per-file table, a "Rule reference" section auto-generated from the diagnostics.RULES registry naming every rule that fired, and a per-NORAD breakdown table listing each satellite whose records were quarantined with its per-rule counts and the source files it appeared in (sorted by quarantined-record count descending, capped at the top 100 with a remainder footer pointing at broken-noradids.ndjson for the long tail).

A run summary is also printed per file to stdout (and as JSON with --report json):

tle2022.txt   8,412,067 records   8,412,064 clean   3 quarantined
  fixes:   trailing-backslash 8,412,064 | reconstructed-checksum 195,293
  rejects: TLE-CHK-001 1 | TLE-PAIR-001 1 | TLE-COL-001 1

Reject counts key by the stable RuleID registry (e.g. TLE-CHK-001 for checksum mismatch, TLE-PAIR-001 for orphan lines, TLE-COL-001 for wrong length) — the same handles cited in report.md and the .broken.txt sidecar so a defect surfaces under one identifier across every artifact a run emits. reconstructed-checksum is reported separately from content-preserving fixes: those records are format-conformant, but their checksums are computed, not independently verified.

validate writes nothing — it only prints the per-file summary and the locations of defective records to stdout.

Progress

A 30 GB run is not silent. Live progress is written to stderr as it goes — so it never pollutes the stdout summary or a --report json pipe:

processing 29 file(s) with 10 worker(s)...
  tle2004_7of8.txt: 5,000,000 records...
[3/29] tle2004_3of8.txt — 2,527,820 clean, 183 quarantined

A worker emits a record-count line every 1,000,000 records; the main process prints an [k/N] line as each file finishes.

Results on the bundled corpus

A full run over the 29-file corpus (tle2004tle2025, ~232 million records):

  • 99.96 % cleaned — 187.9 M trailing-\ artifacts stripped, 71.3 M missing checksums reconstructed
  • 0.044 % quarantined (103,228 records) as genuinely corrupt — every reject fell into an anticipated category; no unknown defect type surfaced

Development

uv sync                          # install dev dependencies
uv run pytest                    # run the test suite
uv run pytest --cov=lintle       # with a coverage report
uv run ruff check                # lint
uv run ruff format               # auto-format

The suite includes unit tests per module, an asymmetric cross-check against the trusted sgp4 parser (a known-good TLE must be accepted by both), and end-to-end integration tests (golden output, idempotence, re-validation).

Code quality is enforced with ruff (lint rule sets E, F, I, UP, B, SIM; 88-column lines) and coverage is measured with pytest-cov.

Project layout

src/lintle/
  tle.py          # core: defines a "perfect" TLE record (pure, no I/O)
  diagnostics.py  # stable RuleID registry + structured Diagnostic dataclass
  categories.py   # FixClass enum + FixSpec registry — the repair taxonomy
  explain_examples.py # validator-verified examples + citations backing `explain`
  repair.py       # speculative, validated repairs
  pipeline.py     # streaming reader, prefix-driven pairing, per-file routing
  report.py       # quarantine sidecar + run-summary rendering
  diff.py         # read-only: per-rule delta between two runs (`lintle diff`)
  explain.py      # read-only: renders rule/fix documentation (`lintle explain`)
  cli.py          # argument parsing, parallelism, exit codes
tests/            # pytest suite
docs/superpowers/
  specs/          # the design specification
  plans/          # the implementation plan
  runs/           # corpus-run summaries

diagnostics.py and categories.py are pure-data leaves of the dependency graph — they hold enums and frozen dataclasses, no logic; explain_examples.py is pure data too, composing those leaves into documented examples. repair, pipeline, and report depend on them; diff.py and explain.py are read-only consumers reached only through cli.py; tle.py remains the single source of truth for what counts as a valid TLE record.

Further reading

The full design rationale — the defect model, the TLE column specification, the fix policy, and the architecture — is in docs/superpowers/specs/2026-05-21-tle-corpus-cleaner-design.md.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lintle-0.3.0.tar.gz (281.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lintle-0.3.0-py3-none-any.whl (61.9 kB view details)

Uploaded Python 3

File details

Details for the file lintle-0.3.0.tar.gz.

File metadata

  • Download URL: lintle-0.3.0.tar.gz
  • Upload date:
  • Size: 281.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for lintle-0.3.0.tar.gz
Algorithm Hash digest
SHA256 fa53df669cfa684fd8d149c9c9e40e9d1a415de10837892245eaa1bf5e06f8ed
MD5 ee4389de8d3e3870afa6c5d893c02f0a
BLAKE2b-256 b4f64d40e3e078cf75196c14a9feb06ee3b66c388935a52b7e563a5cd358082d

See more details on using hashes here.

File details

Details for the file lintle-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: lintle-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 61.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for lintle-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e8ec754fdd4eaca119aebc9469d953f16a39740f1cb63c85b4b78577eb877320
MD5 80584da42c5df11aa25b16c0075595cf
BLAKE2b-256 47c90a093e5784b879d4672a83251572cb9baf4bee6fac5ce3aa1d9edd3e75b7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page