Skip to content

ladybug-tools/dragonfly-schema

Repository files navigation

Build Status Coverage Status

Python 3.7

dragonfly-schema

Dragonfly Data-Model that generates documentation and OpenAPI specifications for the DFJSON file schema.

Installation

pip install dragonfly-schema

QuickStart

import dragonfly_schema

API Documentation

Model Schema

Energy Simulation Parameter Schema

Local Development

  1. Clone this repo locally
git clone [email protected]:ladybug-tools/dragonfly-schema

# or

git clone https://github.com/ladybug-tools/dragonfly-schema
  1. Install dependencies:
cd dragonfly-schema
pip install -r dev-requirements.txt
pip install -r requirements.txt
  1. Run Tests:
python -m pytest tests/
  1. Generate Documentation:
python ./docs.py
  1. Generate Sample Files:
python ./scripts/export_samples.py