tods-validate 0.1.0__tar.gz

tods_validate-0.1.0/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "WebSearch",
+      "WebFetch(domain:ods.calitp.org)"
+    ]
+  }
+}

tods_validate-0.1.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: monthly

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

@@ -0,0 +1,54 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: python -m pip install ".[dev]"
+      - run: ruff check src tests scripts
+      - run: ruff format --check src tests scripts
+      - run: mypy
+
+  docs-drift:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: python -m pip install .
+      - name: Check that docs/rules.md matches the rule registry
+        run: |
+          python scripts/generate_rules_doc.py --check
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python -m pip install ".[dev]"
+      - run: pytest --cov --cov-report=term-missing
+
+  action-self-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run the action against the valid fixture feed
+        uses: ./
+        with:
+          path: tests/fixtures/valid/tods
+          gtfs: tests/fixtures/valid/gtfs

tods_validate-0.1.0/.gitignore

@@ -0,0 +1,16 @@
+# local working notes, not part of the published repo
+CLAUDE.md
+CLAUDE-*.md
+
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+.coverage
+htmlcov/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.DS_Store

tods_validate-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        exclude: ^tests/fixtures/
+      - id: check-yaml
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.5
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.11.0
+    hooks:
+      - id: mypy
+        files: ^src/
+        additional_dependencies: [click]

tods_validate-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

tods_validate-0.1.0/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: tods-validate
+Version: 0.1.0
+Summary: Validator for Transit Operational Data Standard (TODS) feeds, formerly the Operational Data Standard (ODS)
+Project-URL: Repository, https://github.com/ChelseaKR/tods-validate
+Project-URL: TODS specification, https://tods-transit.org/spec/
+Author: Chelsea Kelly-Reif
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: cal-itp,gtfs,ods,tods,transit,validation
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Other Audience
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.11
+Requires-Dist: click>=8.1
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pre-commit>=3.7; extra == 'dev'
+Requires-Dist: pytest-cov>=5; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# tods-validate
+
+A validator for [Transit Operational Data Standard (TODS)](https://tods-transit.org/)
+feeds, with a CLI and a GitHub Action.
+
+TODS is an open standard for describing scheduled transit operations: crew
+runs, deadheads, vehicle assignments, and other non-public service that GTFS
+does not cover. It works as an overlay on an agency's GTFS feed. The standard
+was originally published by Cal-ITP as the Operational Data Standard (ODS)
+and is now maintained with MobilityData under its current name. This
+validator checks feeds against the current spec, TODS v2.1.0.
+
+`tods-validate` reads a TODS package, checks it against the spec, and reports
+findings in language a scheduler can act on. Each finding says what is wrong,
+where, and what good looks like, and cites the spec section it comes from.
+
+## Install
+
+Requires Python 3.11 or newer.
+
+```sh
+pipx install tods-validate
+```
+
+or `pip install tods-validate` into an environment of your choice.
+
+## Usage
+
+Point it at the directory or .zip file containing your TODS files. If your
+GTFS feed lives in a separate file, pass it with `--gtfs` so trip, stop,
+service, and block references can be checked:
+
+```sh
+tods-validate exports/tods/ --gtfs exports/gtfs.zip
+```
+
+When the TODS files sit next to the GTFS files in one package, the GTFS files
+are picked up automatically:
+
+```console
+$ tods-validate /tmp/demo-feed
+tods-validate: /tmp/demo-feed (TODS v2.1.0)
+
+2 errors:
+  ERROR TODS-E203 [run_events.txt, row 4, field 'end_time']
+    run_events.txt row 4: end_time is '9:45', which is not a valid time. Use HH:MM:SS, e.g. '09:45:00' or '25:10:00' for 1:10 AM the next service day.
+  ERROR TODS-E307 [run_events.txt, row 4, field 'trip_id']
+    run_events.txt row 4: trip_id 'WKDY-1002' does not exist in the companion GTFS trips.txt (after applying trips_supplement.txt). Run events that represent work on a trip must reference a scheduled trip.
+    Fix: Correct the trip_id, or add the trip via trips_supplement.txt if it is non-revenue service.
+
+Summary: 2 error(s), 0 warning(s), 0 info.
+$ echo $?
+1
+```
+
+The exit code is 0 when no errors are found, 1 when there are errors, and 2
+when the package cannot be read at all. Warnings do not fail the run unless
+you pass `--fail-on warning`.
+
+Other output formats:
+
+- `--format json` prints a stable JSON document for tooling.
+- `--format github` prints GitHub Actions workflow annotations.
+
+References into GTFS are resolved after applying the supplement files, so a
+trip added by `trips_supplement.txt` is a valid target for
+`run_events.trip_id`, and a stop deleted by `stops_supplement.txt` is not.
+
+## GitHub Action
+
+If your TODS export lives in a repository, this workflow validates it on
+every pull request and annotates findings inline:
+
+```yaml
+name: Validate TODS feed
+on: [pull_request]
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ChelseaKR/tods-validate@v0
+        with:
+          path: feed/tods
+          gtfs: feed/gtfs        # omit if GTFS files sit next to the TODS files
+```
+
+## Rules
+
+The full catalog of checks, with IDs, severities, and spec citations, is in
+[docs/rules.md](docs/rules.md). Rule IDs are stable: a CI pipeline can safely
+filter or suppress specific IDs.
+
+Ambiguities in the spec discovered while building the validator are tracked
+in [docs/spec-questions.md](docs/spec-questions.md).
+
+## What this does not check
+
+`tods-validate` validates the TODS files and their references into the
+companion GTFS feed. It does not re-validate the GTFS feed itself, and it
+does not check that the merged ("TODS-Supplemented") GTFS dataset is valid
+GTFS. For those, run MobilityData's
+[gtfs-validator](https://github.com/MobilityData/gtfs-validator), optionally
+on the merged feed.
+
+## Development
+
+```sh
+git clone https://github.com/ChelseaKR/tods-validate
+cd tods-validate
+python -m venv .venv && . .venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+Lint and type-check with `ruff check src tests scripts` and `mypy`. The rule
+catalog is generated: after adding or changing a rule, run
+`python scripts/generate_rules_doc.py` and commit the result; CI fails if it
+drifts.
+
+## License
+
+Apache-2.0, matching the TODS specification repository.

tods_validate-0.1.0/README.md

@@ -0,0 +1,123 @@
+# tods-validate
+
+A validator for [Transit Operational Data Standard (TODS)](https://tods-transit.org/)
+feeds, with a CLI and a GitHub Action.
+
+TODS is an open standard for describing scheduled transit operations: crew
+runs, deadheads, vehicle assignments, and other non-public service that GTFS
+does not cover. It works as an overlay on an agency's GTFS feed. The standard
+was originally published by Cal-ITP as the Operational Data Standard (ODS)
+and is now maintained with MobilityData under its current name. This
+validator checks feeds against the current spec, TODS v2.1.0.
+
+`tods-validate` reads a TODS package, checks it against the spec, and reports
+findings in language a scheduler can act on. Each finding says what is wrong,
+where, and what good looks like, and cites the spec section it comes from.
+
+## Install
+
+Requires Python 3.11 or newer.
+
+```sh
+pipx install tods-validate
+```
+
+or `pip install tods-validate` into an environment of your choice.
+
+## Usage
+
+Point it at the directory or .zip file containing your TODS files. If your
+GTFS feed lives in a separate file, pass it with `--gtfs` so trip, stop,
+service, and block references can be checked:
+
+```sh
+tods-validate exports/tods/ --gtfs exports/gtfs.zip
+```
+
+When the TODS files sit next to the GTFS files in one package, the GTFS files
+are picked up automatically:
+
+```console
+$ tods-validate /tmp/demo-feed
+tods-validate: /tmp/demo-feed (TODS v2.1.0)
+
+2 errors:
+  ERROR TODS-E203 [run_events.txt, row 4, field 'end_time']
+    run_events.txt row 4: end_time is '9:45', which is not a valid time. Use HH:MM:SS, e.g. '09:45:00' or '25:10:00' for 1:10 AM the next service day.
+  ERROR TODS-E307 [run_events.txt, row 4, field 'trip_id']
+    run_events.txt row 4: trip_id 'WKDY-1002' does not exist in the companion GTFS trips.txt (after applying trips_supplement.txt). Run events that represent work on a trip must reference a scheduled trip.
+    Fix: Correct the trip_id, or add the trip via trips_supplement.txt if it is non-revenue service.
+
+Summary: 2 error(s), 0 warning(s), 0 info.
+$ echo $?
+1
+```
+
+The exit code is 0 when no errors are found, 1 when there are errors, and 2
+when the package cannot be read at all. Warnings do not fail the run unless
+you pass `--fail-on warning`.
+
+Other output formats:
+
+- `--format json` prints a stable JSON document for tooling.
+- `--format github` prints GitHub Actions workflow annotations.
+
+References into GTFS are resolved after applying the supplement files, so a
+trip added by `trips_supplement.txt` is a valid target for
+`run_events.trip_id`, and a stop deleted by `stops_supplement.txt` is not.
+
+## GitHub Action
+
+If your TODS export lives in a repository, this workflow validates it on
+every pull request and annotates findings inline:
+
+```yaml
+name: Validate TODS feed
+on: [pull_request]
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ChelseaKR/tods-validate@v0
+        with:
+          path: feed/tods
+          gtfs: feed/gtfs        # omit if GTFS files sit next to the TODS files
+```
+
+## Rules
+
+The full catalog of checks, with IDs, severities, and spec citations, is in
+[docs/rules.md](docs/rules.md). Rule IDs are stable: a CI pipeline can safely
+filter or suppress specific IDs.
+
+Ambiguities in the spec discovered while building the validator are tracked
+in [docs/spec-questions.md](docs/spec-questions.md).
+
+## What this does not check
+
+`tods-validate` validates the TODS files and their references into the
+companion GTFS feed. It does not re-validate the GTFS feed itself, and it
+does not check that the merged ("TODS-Supplemented") GTFS dataset is valid
+GTFS. For those, run MobilityData's
+[gtfs-validator](https://github.com/MobilityData/gtfs-validator), optionally
+on the merged feed.
+
+## Development
+
+```sh
+git clone https://github.com/ChelseaKR/tods-validate
+cd tods-validate
+python -m venv .venv && . .venv/bin/activate
+pip install -e ".[dev]"
+pytest
+```
+
+Lint and type-check with `ruff check src tests scripts` and `mypy`. The rule
+catalog is generated: after adding or changing a rule, run
+`python scripts/generate_rules_doc.py` and commit the result; CI fails if it
+drifts.
+
+## License
+
+Apache-2.0, matching the TODS specification repository.

tods_validate-0.1.0/action.yml

@@ -0,0 +1,38 @@
+name: tods-validate
+description: >-
+  Validate a Transit Operational Data Standard (TODS) feed and annotate
+  findings on the pull request.
+branding:
+  icon: check-circle
+  color: green
+
+inputs:
+  path:
+    description: Directory or .zip file containing the TODS files.
+    required: true
+  gtfs:
+    description: >-
+      Companion GTFS feed (directory or .zip). Leave empty if the GTFS files
+      sit next to the TODS files.
+    required: false
+    default: ""
+  fail-on:
+    description: Fail the job on findings at or above this severity (error or warning).
+    required: false
+    default: error
+
+runs:
+  using: composite
+  steps:
+    - name: Install tods-validate
+      shell: bash
+      run: python3 -m pip install --quiet "${{ github.action_path }}"
+
+    - name: Validate feed
+      shell: bash
+      run: |
+        args=("${{ inputs.path }}" --format github --fail-on "${{ inputs['fail-on'] }}")
+        if [ -n "${{ inputs.gtfs }}" ]; then
+          args+=(--gtfs "${{ inputs.gtfs }}")
+        fi
+        tods-validate "${args[@]}"