xdfetch 0.0.1__py3-none-any.whl

xdfetch/__init__.py

@@ -0,0 +1,5 @@
+"""xdfetch: fetch crossword puzzles as their outlets serve them, and convert them to .xd."""
+
+__version__ = "0.0.1"
+
+USER_AGENT = f"xdfetch/{__version__} (+https://github.com/century-arcade/xdfetch)"

xdfetch/__main__.py

@@ -0,0 +1,3 @@
+from .cli import main
+
+raise SystemExit(main())

xdfetch/adapters/__init__.py

@@ -0,0 +1,5 @@
+"""Adapters: one per transport (a plain URL, an embed's API, ...).
+
+An adapter answers two questions for an outlet and a date: where is the file, and what
+did the host send. It returns the bytes as served; it never converts.
+"""

xdfetch/cli.py

@@ -0,0 +1,51 @@
+"""xdfetch command line.
+
+list   the outlets xdfetch knows
+get    fetch one outlet's puzzle and write it as .xd (not written yet)
+"""
+
+from __future__ import annotations
+
+import argparse
+import sys
+
+from . import __version__, registry
+
+
+def cmd_list(args: argparse.Namespace) -> int:
+    outlets = registry.load()
+    for o in sorted(outlets.values(), key=lambda o: o.id):
+        print(f"{o.id}\t{o.days}\t{o.homepage}")
+    return 0
+
+
+def cmd_get(args: argparse.Namespace) -> int:
+    print("xdfetch get: not written yet", file=sys.stderr)
+    return 2
+
+
+def build_parser() -> argparse.ArgumentParser:
+    p = argparse.ArgumentParser(
+        prog="xdfetch", description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter
+    )
+    p.add_argument("--version", action="version", version=f"xdfetch {__version__}")
+    sub = p.add_subparsers(dest="command", required=True)
+
+    sp = sub.add_parser("list", help="the outlets xdfetch knows")
+    sp.set_defaults(func=cmd_list)
+
+    sp = sub.add_parser("get", help="fetch one outlet's puzzle and write it as .xd")
+    sp.add_argument("outlet")
+    sp.add_argument("--date", help="YYYY-MM-DD (default: the outlet's latest)")
+    sp.set_defaults(func=cmd_get)
+
+    return p
+
+
+def main(argv: list[str] | None = None) -> int:
+    args = build_parser().parse_args(argv)
+    return args.func(args)
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

xdfetch/convert/__init__.py

@@ -0,0 +1,5 @@
+"""Converters: one per format, chosen by sniffing the bytes, never by file extension.
+
+A converter takes the bytes an outlet served and builds a Puzzle. Whatever the source has
+that .xd can't carry is listed on the Puzzle, not dropped silently.
+"""

xdfetch/outlets.tsv

@@ -0,0 +1 @@
+id	adapter	params	days	tz	homepage	notes

xdfetch/registry.py

@@ -0,0 +1,41 @@
+"""The outlet registry: outlets.tsv, one row per outlet.
+
+Columns:
+    id               the outlet's id, following the xd corpus's publication ids
+    adapter          which adapter fetches it (see xdfetch.adapters)
+    params           the adapter's parameters, as space-separated key=value
+    days             publication days: daily, mon-sat, sun, ...
+    tz               the outlet's time zone, for "today"
+    homepage         the outlet's own page for its puzzles
+    notes            anything worth knowing
+"""
+
+from __future__ import annotations
+
+import csv
+from dataclasses import dataclass
+from pathlib import Path
+
+OUTLETS_TSV = Path(__file__).with_name("outlets.tsv")
+
+
+@dataclass(frozen=True)
+class Outlet:
+    id: str
+    adapter: str
+    params: str = ""
+    days: str = "daily"
+    tz: str = "America/New_York"
+    homepage: str = ""
+    notes: str = ""
+
+
+def load(path: Path = OUTLETS_TSV) -> dict[str, Outlet]:
+    """Read a registry file. Later rows with the same id replace earlier ones."""
+    outlets: dict[str, Outlet] = {}
+    with path.open(encoding="utf-8", newline="") as f:
+        for row in csv.DictReader(f, delimiter="\t"):
+            fields = {k: (v or "") for k, v in row.items() if k in Outlet.__dataclass_fields__}
+            outlet = Outlet(**fields)
+            outlets[outlet.id] = outlet
+    return outlets

xdfetch-0.0.1.dist-info/METADATA

@@ -0,0 +1,56 @@
+Metadata-Version: 2.5
+Name: xdfetch
+Version: 0.0.1
+Summary: Fetch crossword puzzles from online outlets and convert them to .xd
+Project-URL: Homepage, https://github.com/century-arcade/xdfetch
+Project-URL: Repository, https://github.com/century-arcade/xdfetch
+Project-URL: Issues, https://github.com/century-arcade/xdfetch/issues
+Author: Alex DeJarnatt
+License-Expression: MIT
+License-File: LICENSE
+Keywords: crossword,downloader,puzzles,xd
+Classifier: Development Status :: 1 - Planning
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Games/Entertainment :: Puzzle Games
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# xdfetch
+
+Fetches crossword puzzles from the outlets that publish them online and converts them to
+[.xd](https://github.com/century-arcade/xdformat), the plain-text crossword format of the
+[xd corpus](https://github.com/century-arcade/xd).
+
+**Status: just started.** The package installs and the command runs, but it can't fetch
+anything yet. [DESIGN.md](DESIGN.md) has the plan.
+
+## What it will do
+
+    pip install xdfetch
+    xdfetch list                        # the outlets it knows
+    xdfetch get lat                     # today's LA Times -> lat2026-11-09.xd
+    xdfetch get nyt --date 2026-11-01   # with your own subscription cookie in NYT_S
+    xdfetch run --store ./archive --start 2026-10-01 --end 2026-10-31   # keep an archive
+
+Three rules shape it:
+
+1. **Fetch keeps the bytes as served.** The file the outlet sent is kept as it was, and
+   conversion reads from that.
+2. **Convert is separate:** one converter per *format*, not per outlet, chosen by looking
+   at the content. Anything a source has that .xd can't carry is reported, never dropped
+   silently.
+3. **Most outlets are a row, not code.** `outlets.tsv` says where each outlet's file is and
+   when it publishes; code is only needed for a new kind of host.
+
+## Development
+
+    uv sync --group dev
+    uv run pytest
+    uv run ruff check
+
+## License
+
+MIT. See [LICENSE](LICENSE).

xdfetch-0.0.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+xdfetch/__init__.py,sha256=2cLAjkCeyDyPOLzXlrJp5hBHc_0ctKDR3T68nvH0uz0,200
+xdfetch/__main__.py,sha256=k1ocEWawweo1qCJWNFAAvyxz3tcY13dzvCenHszij30,48
+xdfetch/cli.py,sha256=rdtVqvZ5Nd41PoSvOJWzLeVxX6ZNn5w4MTMGc52GPpc,1407
+xdfetch/outlets.tsv,sha256=hWuU-x3VI0YmGPT-ZneM6NTsJE82ilm2iSqf3bZtwIA,41
+xdfetch/registry.py,sha256=yljLJuJEfQJ98X0v_PdeKP6yTz9ZyL4jE00pu-uLpsU,1351
+xdfetch/adapters/__init__.py,sha256=Xvw5nWqetcO2qQ00Qr8dvROL_TlPLgcK0HgNg5EQ15s,229
+xdfetch/convert/__init__.py,sha256=YlLc6ni2HpPR-vqRDATYOYrsDF1fat0ER65HHbLy7Yc,249
+xdfetch-0.0.1.dist-info/METADATA,sha256=fOq4T18l-5GsOsfgFXC_dzAkNygdPaMqpikB5QqL_-0,2155
+xdfetch-0.0.1.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+xdfetch-0.0.1.dist-info/entry_points.txt,sha256=nbVgi63O7_e4cyH4D5SZSMcmjec_0Flsl2PMKe0QQG8,45
+xdfetch-0.0.1.dist-info/licenses/LICENSE,sha256=4XmtFFPTUKdPrypVToYNo6_d4Zd_uc2uaZV6OQ8D_ok,1081
+xdfetch-0.0.1.dist-info/RECORD,,

xdfetch-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

xdfetch-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+xdfetch = xdfetch.cli:main

xdfetch-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 century-arcade
+
+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.