diff options
| author | Kieran Bingham <kieran.bingham+renesas@ideasonboard.com> | 2018-11-01 11:48:03 +0000 |
|---|---|---|
| committer | Kieran Bingham <kieran.bingham+renesas@ideasonboard.com> | 2018-12-07 11:27:59 +0000 |
| commit | 286cf9ae26bb9545bfaf82730355863e38fdbe4a (patch) | |
| tree | 02da8a59ebc529a0c8cc5f6a1bb5b5d2e6d52fb0 /README.md | |
| parent | f3e0f5d843a4a7266019e1b47de6537eb5aa33cc (diff) | |
periject: YAML Validation
Utilise pykwalify to provide a YAML schema for our data files. Define
an initial project schema under projects/ to define our data layout. An
example task data file is provided to demonstrate how the data could be
presented in text form.
A validator is provided which currently simply calls pykwalify. This is
just an initial demonstration of the validation process and can be
expanded upon later to provide automa{t,g}ic commit title processing,
and further business logic can be added with extra tools.
Signed-off-by: Kieran Bingham <kieran.bingham+renesas@ideasonboard.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..46e2483 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# PeriJect: A git-backed task management system + +Data is stored through a folder hierarchy in yaml data files. Data can be +edited by hand and validated using the provided schema files or tools can be +developed to aid the creation and manipulation of the data sources. + +## Project Dependancies: + + - pykwalify: + + Documentation: https://pykwalify.readthedocs.io/ + Installation: pip3 install pykwalify + + Custom validation is possible with pykwalify which may assist with complex + use cases in the future. See: + + - https://pykwalify.readthedocs.io/en/unstable/extensions.html#how-custom-validation-works |