Update README with hatch based instructions #86
1 changed files with 28 additions and 4 deletions
32
README.md
32
README.md
|
|
@ -6,22 +6,46 @@ https://concepts.inm7.de
|
||||||
|
|
||||||
## How to...
|
## How to...
|
||||||
|
|
||||||
Install (in a virtualenv)
|
Use hatch to contribute to this project:
|
||||||
|
|
||||||
```
|
```
|
||||||
pip install -r requirements.txt
|
pip install hatch
|
||||||
```
|
```
|
||||||
|
|
||||||
Build docs:
|
Build docs:
|
||||||
|
|
||||||
```
|
```
|
||||||
make
|
hatch run docs:build
|
||||||
```
|
```
|
||||||
|
|
||||||
Serve docs locally
|
Serve docs locally
|
||||||
|
|
||||||
```
|
```
|
||||||
mkdocs serve
|
hatch run docs:serve
|
||||||
|
```
|
||||||
|
|
||||||
|
Run all model checks:
|
||||||
|
|
||||||
|
```
|
||||||
|
hatch run check:models
|
||||||
|
```
|
||||||
|
|
||||||
|
Run specific model checks:
|
||||||
|
|
||||||
|
```
|
||||||
|
hatch shell
|
||||||
|
make checkmodel/<path/to/schema>
|
||||||
|
# example:
|
||||||
|
make checkmodel/flat-data/unreleased
|
||||||
|
```
|
||||||
|
|
||||||
|
Validate a specific model:
|
||||||
|
|
||||||
|
```
|
||||||
|
hatch shell
|
||||||
|
linkml validate -s src/<path/to/schema-file>.yaml --config src/<path/to/example>.valid.cfg.yaml src/<path/to/example>.yaml
|
||||||
|
# example:
|
||||||
|
linkml validate -s src/flat-data/unreleased.yaml --config src/flat-data/unreleased/validation/Dataset.valid.cfg.yaml src/flat-data/unreleased/examples/Dataset-1.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
Presently, this work require a patched linkml installation. The patch(es) are
|
Presently, this work require a patched linkml installation. The patch(es) are
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue