pyrailworks 0.1.0__tar.gz

pyrailworks-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[dev]
+
+    - name: Run tests
+      run: |
+        pytest -v

pyrailworks-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.12"
+
+    - name: Install build
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+
+    - name: Build distribution artifacts
+      run: |
+        python -m build
+
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

pyrailworks-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+.venv/
+__pycache__/
+*.pyc
+.pytest_cache/
+.coverage
+htmlcov/
+dist/
+build/
+*.egg-info/
+.scratch/

pyrailworks-0.1.0/AGENTS.md

@@ -0,0 +1,15 @@
+# pyrailworks
+
+## Agent skills
+
+### Issue tracker
+
+Issues and specs live in GitHub Issues using the `gh` CLI. See `docs/agents/issue-tracker.md`.
+
+### Triage labels
+
+Canonical triage roles (`needs-triage`, `needs-info`, `ready-for-agent`, `ready-for-human`, `wontfix`). See `docs/agents/triage-labels.md`.
+
+### Domain docs
+
+Single-context repository layout (`CONTEXT.md` and `docs/adr/`). See `docs/agents/domain.md`.

pyrailworks-0.1.0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.5
+Name: pyrailworks
+Version: 0.1.0
+Summary: Python client library for the Public RO Railworks Irish Rail Engineering Works API
+Author: Irishsmurf
+License-Expression: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: respx>=0.21.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pyrailworks
+
+Python client library for the Public RO Railworks API ([https://railworks.paddez.com/docs](https://railworks.paddez.com/docs)).
+
+Provides queryable access to Iarnród Éireann's (Irish Rail) planned engineering works, station days, change logs, and iCalendar feeds.
+
+## Installation
+
+```bash
+pip install pyrailworks
+```
+
+## Quick Start
+
+### Synchronous Client
+
+```python
+from pyrailworks import RailworksClient, LineName
+
+with RailworksClient() as client:
+    # 1. Health check
+    health = client.get_health()
+    print("Upstream checked at:", health.source.checked_at)
+
+    # 2. List stations
+    stations = client.list_stations()
+    print(f"Total stations: {len(stations)}")
+
+    # 3. Check affected days for a station
+    days_resp = client.get_station_days("WBROK")
+    for day in days_resp.days:
+        print(f"Station {days_resp.station.name} affected on {day.date}: {day.effect.value}")
+
+    # 4. List active notices on a line
+    notices = client.list_notices(line=LineName.DART, status="active")
+    for notice in notices.notices:
+        print(f"Notice {notice.id}: {notice.heading} ({notice.starts_on} to {notice.ends_on})")
+
+    # 5. Follow changes with automatic cursor traversal
+    for event in client.iter_changes():
+        print(f"Change event: {event.type.value} on notice {event.notice_id}")
+```
+
+### Asynchronous Client
+
+```python
+import asyncio
+from pyrailworks import AsyncRailworksClient
+
+async def main():
+    async with AsyncRailworksClient() as client:
+        health = await client.get_health()
+        print("Backend stale:", health.source.stale)
+
+        async for event in client.iter_changes():
+            print("Notice changed:", event.notice_id)
+
+asyncio.run(main())
+```
+
+## Features
+
+- **Both Sync & Async**: `RailworksClient` and `AsyncRailworksClient` powered by `httpx`.
+- **Strict Data Validation**: Pydantic v2 data models for type safety, validation, and auto-completion.
+- **Problem Details Handling**: Full support for RFC 9457 errors with specific exceptions (`BadRequestError`, `NotFoundError`, `StationsLoadingError`).
+- **Change Log Streaming**: Helper generators (`iter_changes()`) handling opaque cursor pagination.
+- **Calendar Feeds**: Raw iCalendar text download via `get_calendar_feed()`.

pyrailworks-0.1.0/README.md

@@ -0,0 +1,67 @@
+# pyrailworks
+
+Python client library for the Public RO Railworks API ([https://railworks.paddez.com/docs](https://railworks.paddez.com/docs)).
+
+Provides queryable access to Iarnród Éireann's (Irish Rail) planned engineering works, station days, change logs, and iCalendar feeds.
+
+## Installation
+
+```bash
+pip install pyrailworks
+```
+
+## Quick Start
+
+### Synchronous Client
+
+```python
+from pyrailworks import RailworksClient, LineName
+
+with RailworksClient() as client:
+    # 1. Health check
+    health = client.get_health()
+    print("Upstream checked at:", health.source.checked_at)
+
+    # 2. List stations
+    stations = client.list_stations()
+    print(f"Total stations: {len(stations)}")
+
+    # 3. Check affected days for a station
+    days_resp = client.get_station_days("WBROK")
+    for day in days_resp.days:
+        print(f"Station {days_resp.station.name} affected on {day.date}: {day.effect.value}")
+
+    # 4. List active notices on a line
+    notices = client.list_notices(line=LineName.DART, status="active")
+    for notice in notices.notices:
+        print(f"Notice {notice.id}: {notice.heading} ({notice.starts_on} to {notice.ends_on})")
+
+    # 5. Follow changes with automatic cursor traversal
+    for event in client.iter_changes():
+        print(f"Change event: {event.type.value} on notice {event.notice_id}")
+```
+
+### Asynchronous Client
+
+```python
+import asyncio
+from pyrailworks import AsyncRailworksClient
+
+async def main():
+    async with AsyncRailworksClient() as client:
+        health = await client.get_health()
+        print("Backend stale:", health.source.stale)
+
+        async for event in client.iter_changes():
+            print("Notice changed:", event.notice_id)
+
+asyncio.run(main())
+```
+
+## Features
+
+- **Both Sync & Async**: `RailworksClient` and `AsyncRailworksClient` powered by `httpx`.
+- **Strict Data Validation**: Pydantic v2 data models for type safety, validation, and auto-completion.
+- **Problem Details Handling**: Full support for RFC 9457 errors with specific exceptions (`BadRequestError`, `NotFoundError`, `StationsLoadingError`).
+- **Change Log Streaming**: Helper generators (`iter_changes()`) handling opaque cursor pagination.
+- **Calendar Feeds**: Raw iCalendar text download via `get_calendar_feed()`.

pyrailworks-0.1.0/docs/agents/domain.md

@@ -0,0 +1,51 @@
+# Domain Docs
+
+How the engineering skills should consume this repo's domain documentation when exploring the codebase.
+
+## Before exploring, read these
+
+- **`CONTEXT.md`** at the repo root, or
+- **`CONTEXT-MAP.md`** at the repo root if it exists: it points at one `CONTEXT.md` per context. Read each one relevant to the topic.
+- **`docs/adr/`**: read ADRs that touch the area you're about to work in. In multi-context repos, also check `src/<context>/docs/adr/` for context-scoped decisions.
+
+If any of these files don't exist, **proceed silently**. Don't flag their absence; don't suggest creating them upfront. The `/domain-modeling` skill (reached via `/grill-with-docs` and `/improve-codebase-architecture`) creates them lazily when terms or decisions actually get resolved.
+
+## File structure
+
+Single-context repo (most repos):
+
+```
+/
+├── CONTEXT.md
+├── docs/adr/
+│   ├── 0001-event-sourced-orders.md
+│   └── 0002-postgres-for-write-model.md
+└── src/
+```
+
+Multi-context repo (presence of `CONTEXT-MAP.md` at the root):
+
+```
+/
+├── CONTEXT-MAP.md
+├── docs/adr/                          ← system-wide decisions
+└── src/
+    ├── ordering/
+    │   ├── CONTEXT.md
+    │   └── docs/adr/                  ← context-specific decisions
+    └── billing/
+        ├── CONTEXT.md
+        └── docs/adr/
+```
+
+## Use the glossary's vocabulary
+
+When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `CONTEXT.md`. Don't drift to synonyms the glossary explicitly avoids.
+
+If the concept you need isn't in the glossary yet, that's a signal: either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`).
+
+## Flag ADR conflicts
+
+If your output contradicts an existing ADR, surface it explicitly rather than silently overriding:
+
+> _Contradicts ADR-0007 (event-sourced orders), but worth reopening because…_

pyrailworks-0.1.0/docs/agents/issue-tracker.md

@@ -0,0 +1,45 @@
+# Issue tracker: GitHub
+
+Issues and specs for this repo live as GitHub issues. Use the `gh` CLI for all operations.
+
+## Conventions
+
+- **Create an issue**: `gh issue create --title "..." --body "..."`. Use a heredoc for multi-line bodies.
+- **Read an issue**: `gh issue view <number> --comments`, filtering comments by `jq` and also fetching labels.
+- **List issues**: `gh issue list --state open --json number,title,body,labels,comments --jq '[.[] | {number, title, body, labels: [.labels[].name], comments: [.comments[].body]}]'` with appropriate `--label` and `--state` filters.
+- **Comment on an issue**: `gh issue comment <number> --body "..."`
+- **Apply / remove labels**: `gh issue edit <number> --add-label "..."` / `--remove-label "..."`
+- **Close**: `gh issue close <number> --comment "..."`
+
+Infer the repo from `git remote -v`; `gh` does this automatically when run inside a clone.
+
+## Pull requests as a triage surface
+
+**PRs as a request surface: no.** _(Set to `yes` if this repo treats external PRs as feature requests; `/triage` reads this flag.)_
+
+When set to `yes`, PRs run through the same labels and states as issues, using the `gh pr` equivalents:
+
+- **Read a PR**: `gh pr view <number> --comments` and `gh pr diff <number>` for the diff.
+- **List external PRs for triage**: `gh pr list --state open --json number,title,body,labels,author,authorAssociation,comments` then keep only `authorAssociation` of `CONTRIBUTOR`, `FIRST_TIME_CONTRIBUTOR`, or `NONE` (drop `OWNER`/`MEMBER`/`COLLABORATOR`).
+- **Comment / label / close**: `gh pr comment`, `gh pr edit --add-label`/`--remove-label`, `gh pr close`.
+
+GitHub shares one number space across issues and PRs, so a bare `#42` may be either: resolve with `gh pr view 42` and fall back to `gh issue view 42`.
+
+## When a skill says "publish to the issue tracker"
+
+Create a GitHub issue.
+
+## When a skill says "fetch the relevant ticket"
+
+Run `gh issue view <number> --comments`.
+
+## Wayfinding operations
+
+Used by `/wayfinder`. The **map** is a single issue with **child** issues as tickets.
+
+- **Map**: a single issue labelled `wayfinder:map`, holding the Notes / Decisions-so-far / Fog body. `gh issue create --label wayfinder:map`.
+- **Child ticket**: an issue linked to the map as a GitHub sub-issue (`gh api` on the sub-issues endpoint). Where sub-issues aren't enabled, add the child to a task list in the map body and put `Part of #<map>` at the top of the child body. Labels: `wayfinder:<type>` (`research`/`prototype`/`grilling`/`task`). Once claimed, the ticket is assigned to the driving dev.
+- **Blocking**: GitHub's **native issue dependencies**, the canonical, UI-visible representation. Add an edge with `gh api --method POST repos/<owner>/<repo>/issues/<child>/dependencies/blocked_by -F issue_id=<blocker-db-id>`, where `<blocker-db-id>` is the blocker's numeric **database id** (`gh api repos/<owner>/<repo>/issues/<n> --jq .id`, _not_ the `#number` or `node_id`). GitHub reports `issue_dependencies_summary.blocked_by` (open blockers only, the live gate). Where dependencies aren't available, fall back to a `Blocked by: #<n>, #<n>` line at the top of the child body. A ticket is unblocked when every blocker is closed.
+- **Frontier query**: list the map's open children (`gh issue list --state open`, scoped to the map's sub-issues / task list), drop any with an open blocker (`issue_dependencies_summary.blocked_by > 0`, or an open issue in the `Blocked by` line) or an assignee; first in map order wins.
+- **Claim**: `gh issue edit <n> --add-assignee @me`, the session's first write.
+- **Resolve**: `gh issue comment <n> --body "<answer>"`, then `gh issue close <n>`, then append a context pointer (gist + link) to the map's Decisions-so-far.

pyrailworks-0.1.0/docs/agents/triage-labels.md

@@ -0,0 +1,15 @@
+# Triage Labels
+
+The skills speak in terms of five canonical triage roles. This file maps those roles to the actual label strings used in this repo's issue tracker.
+
+| Label in mattpocock/skills | Label in our tracker | Meaning                                  |
+| -------------------------- | -------------------- | ---------------------------------------- |
+| `needs-triage`             | `needs-triage`       | Maintainer needs to evaluate this issue  |
+| `needs-info`               | `needs-info`         | Waiting on reporter for more information |
+| `ready-for-agent`          | `ready-for-agent`    | Fully specified, ready for an AFK agent  |
+| `ready-for-human`          | `ready-for-human`    | Requires human implementation            |
+| `wontfix`                  | `wontfix`            | Will not be actioned                     |
+
+When a skill mentions a role (e.g. "apply the AFK-ready triage label"), use the corresponding label string from this table.
+
+Edit the right-hand column to match whatever vocabulary you actually use.

pyrailworks-0.1.0/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pyrailworks"
+version = "0.1.0"
+description = "Python client library for the Public RO Railworks Irish Rail Engineering Works API"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [
+    { name = "Irishsmurf" }
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.24.0",
+    "pydantic>=2.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.23.0",
+    "respx>=0.21.0",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]

pyrailworks-0.1.0/src/pyrailworks/__init__.py

@@ -0,0 +1,81 @@
+"""pyrailworks - Python client for the Public RO Railworks API."""
+from pyrailworks.client import AsyncRailworksClient, RailworksClient
+from pyrailworks.exceptions import (
+    BadRequestError,
+    NotFoundError,
+    ProblemError,
+    RailworksError,
+    StationsLoadingError,
+)
+from pyrailworks.models import (
+    AlterationChange,
+    ChangeEvent,
+    ChangeEventType,
+    ChangesResponse,
+    DateInference,
+    DateInferenceMethod,
+    DaySection,
+    Effect,
+    EffectKind,
+    Extraction,
+    ExtractionStatus,
+    Health,
+    LineName,
+    NoticeResponse,
+    NoticeStatus,
+    NoticesResponse,
+    RawNoticeResponse,
+    Revision,
+    SegmentExpansion,
+    ServiceAlteration,
+    Source,
+    Station,
+    StationDay,
+    StationDaysResponse,
+    StationLine,
+    StationResponse,
+    StationsResponse,
+    TimeScope,
+    WorksNotice,
+    WorksSegment,
+)
+
+__all__ = [
+    "RailworksClient",
+    "AsyncRailworksClient",
+    "RailworksError",
+    "ProblemError",
+    "BadRequestError",
+    "NotFoundError",
+    "StationsLoadingError",
+    "LineName",
+    "NoticeStatus",
+    "EffectKind",
+    "AlterationChange",
+    "ExtractionStatus",
+    "DateInferenceMethod",
+    "SegmentExpansion",
+    "ChangeEventType",
+    "Source",
+    "DateInference",
+    "DaySection",
+    "WorksSegment",
+    "Effect",
+    "ServiceAlteration",
+    "Extraction",
+    "Revision",
+    "WorksNotice",
+    "ChangeEvent",
+    "StationLine",
+    "Station",
+    "TimeScope",
+    "StationDay",
+    "Health",
+    "NoticesResponse",
+    "NoticeResponse",
+    "RawNoticeResponse",
+    "ChangesResponse",
+    "StationsResponse",
+    "StationResponse",
+    "StationDaysResponse",
+]