Materials-Consortia / Materials-Consortia/optimade-python-tools
Improve validator interactive usage
Open
Nobody has claimed this yet.
priority/low
validator
- Dominant language
- Python
- Stars
- 91
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
When using the validator interactively (i.e. inside another script) many of the useful CLI features like fail-fast and logging do not work particularly well. Some suggestions:
- Move away from using
SystemExitto cleanly abort on failure, instead wrap a custom exception - Add a "real" 0 verbosity level where absolutely nothing is printed under any circumstance
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the validator's interactive and CLI entry points, then locate the failure paths that call SystemExit and the code controlling verbosity. The work is done when interactive use can abort through a custom exception and a true zero-verbosity mode produces no output, with existing CLI behavior preserved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100