Add validation program

Open
  • Is something wrong?
#25 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
data

Research direction

The issue proposes a separate utility to validate files, including checking constraints and whether sufficient information is present, but names no files, tests, or entry points. Start by reading the data model and example code to learn how files are represented; done means a utility can check converter output against the applicable constraints and report missing information.

Written by the indexing model from the issue text.

Description

enhancement help wanted

yardl can currently not express constraints https://github.com/microsoft/yardl/issues/176, but some might be added later. Nevertheless, it is unlikely that this will cover all constraints that would be useful to have. In addition, it would be suboptimal if a "reader" would check those constraints all the time, as this will likely reduce performance.

One way around this is to have a separate utility that "validates" a file: are all constraints satisfied? Is sufficient information present? This would be very useful to test output of converters.

Dominant language
Python
Stars
15
Forks
18
Avg merge
1d 11h
Merged PRs (30d)
12

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ETSInitiative/PETSIRD

All issues in ETSInitiative/PETSIRD

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.