https://github.com/inbo/whip
✅ Human and machine-readable syntax to express specifications for data
https://github.com/inbo/whip
data-validation oscibio specification
Last synced: 4 months ago
JSON representation
✅ Human and machine-readable syntax to express specifications for data
- Host: GitHub
- URL: https://github.com/inbo/whip
- Owner: inbo
- License: mit
- Created: 2016-12-07T15:32:41.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-11-19T11:32:13.000Z (about 4 years ago)
- Last Synced: 2025-01-11T19:42:53.159Z (about 1 year ago)
- Topics: data-validation, oscibio, specification
- Homepage:
- Size: 41 KB
- Stars: 7
- Watchers: 11
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# whip
Whip is a human and machine-readable syntax to express **specifications for data**. It can be used as a whip to test how well data meets certain specifications, be it a feather :sweat_smile: or a chain whip :scream:.
Example:
```yaml
my_date_field:
dateformat: ['%Y-%m-%d', '%Y-%m', '%Y'] # Needs to be ISO8601 format, but don't allow ranges
mindate: 1830-01-01 # No dates before 1830
empty: True # Empty values are allowed
```
## Documentation
- [Syntax](docs/syntax.md)
## Implementations
You can test whip specifications with [pywhip](https://inbo.github.io/pywhip/).
## Contributors
- [Peter Desmet](https://github.com/peterdesmet)
- [Stijn Van Hoey](https://github.com/stijnvanhoey)
- [Christian Gendreau](https://github.com/cgendreau)
- [Dimitri Brosens](https://github.com/DimEvil)
- [John Wieczorek](https://github.com/tucotuco)
## License
[MIT License](LICENSE)