dvc-pipeline-schema

JSON Schema for dvc.yaml file format.

It can provide better autocompletion, validation and linting for dvc.yaml files.

Usage

JSON Schema

Use the following URL for the up-to-date JSON schema for dvc.yaml:

https://raw.githubusercontent.com/iterative/pipeline-schema/master/schema.json

Usage with VSCode (with YAML Extension):

Add the following to your settings:

{
  "yaml.schemas": {
    "https://raw.githubusercontent.com/iterative/pipeline-schema/master/schema.json":
        "dvc.yaml"
  }
}

Usage with Intellij IDE (PyCharm et al.)

Follow this instruction.

Important Files:

1. schema.json
2. gen.py
3. examples
4. tests.py

Contributing

1. Open gen.py and make some adjustments.
2. Generate schema and run tests:

   $ dvc repro

3. Send us a pull request. 🤗

Make sure to create a virtual environment before, and dvc is installed.