https://github.com/ladybug-tools/dragonfly-schema

:dragon: :scroll: Dragonfly Data Model Objects
https://github.com/ladybug-tools/dragonfly-schema

Last synced: 4 months ago
JSON representation

:dragon: :scroll: Dragonfly Data Model Objects

• Host: GitHub
• URL: https://github.com/ladybug-tools/dragonfly-schema
• Owner: ladybug-tools
• License: mit
• Created: 2020-01-16T03:41:03.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2026-02-03T16:00:16.000Z (4 months ago)
• Last Synced: 2026-02-04T05:29:07.367Z (4 months ago)
• Language: Python
• Homepage: https://ladybug-tools.github.io/dragonfly-schema
• Size: 1000 KB
• Stars: 5
• Watchers: 3
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![Build Status](https://travis-ci.com/ladybug-tools/dragonfly-schema.svg?branch=master)](https://travis-ci.com/ladybug-tools/dragonfly-schema)

[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/dragonfly-schema/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/dragonfly-schema)

[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-370/)

# dragonfly-schema

Dragonfly Data-Model that generates documentation and OpenAPI specifications for

the DFJSON file schema.

## Installation

```console

pip install dragonfly-schema

```

## QuickStart

```python

import dragonfly_schema

```

## API Documentation

[Model Schema](https://ladybug-tools.github.io/dragonfly-schema/model.html)

[Energy Simulation Parameter Schema](https://ladybug-tools-in2.github.io/honeybee-schema/simulation-parameter.html)

## Local Development

1. Clone this repo locally

```console

git clone git@github.com:ladybug-tools/dragonfly-schema

# or

git clone https://github.com/ladybug-tools/dragonfly-schema

```

2. Install dependencies:

```console

cd dragonfly-schema

pip install -r dev-requirements.txt

pip install -r requirements.txt

```

3. Run Tests:

```console

python -m pytest tests/

```

4. Generate Documentation:

```python

python ./docs.py

```

5. Generate Sample Files:

```python

python ./scripts/export_samples.py

```