Skip to main content

Dragonfly Data-Model Objects

Project description

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 git@github.com: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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dragonfly_schema-1.15.1.tar.gz (18.1 kB view details)

Uploaded Source

Built Distribution

dragonfly_schema-1.15.1-py2.py3-none-any.whl (21.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file dragonfly_schema-1.15.1.tar.gz.

File metadata

  • Download URL: dragonfly_schema-1.15.1.tar.gz
  • Upload date:
  • Size: 18.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for dragonfly_schema-1.15.1.tar.gz
Algorithm Hash digest
SHA256 cb7a508b25efca108bd09179b2f5019f70b8e559036772594737e53351825143
MD5 0fac836f72ceb500af1ae11c65b5dcd2
BLAKE2b-256 f38c7d646943784ad03c4dd2a1962c29657190f96c6d814f4b2f8be8b9af8eca

See more details on using hashes here.

File details

Details for the file dragonfly_schema-1.15.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for dragonfly_schema-1.15.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3c1d6a588f7af7446ae7612c477f03dace46be73734adea93c6bbe52f1625b76
MD5 abc8330e1f36efab6dc28669bddceec2
BLAKE2b-256 6937b67b53fa573566b6b7cc531f9cbfc60dd236c51a480d24cc5c1241a29d94

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page