Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 1.66 KB

File metadata and controls

54 lines (38 loc) · 1.66 KB

Dragonfly DesignBuilder

Build Status

Python 3.10

Dragonfly extension for translation to/from DesignBuilder.

Translation is accomplished using XML files following the DesignBuilder DsbXML Schema. Files can be imported to DesignBuilder using the DsbXML Importer

Installation

pip install -U dragonfly-designbuilder

To check if the command line interface is installed correctly use dragonfly-designbuilder --help.

QuickStart

import dragonfly_designbuilder

Local Development

  1. Clone this repo locally
git clone git@github.com:ladybug-tools/dragonfly-designbuilder

# or

git clone https://github.com/ladybug-tools/dragonfly-designbuilder
  1. Install dependencies:
cd dragonfly-designbuilder
pip install -r dev-requirements.txt
pip install -r requirements.txt
  1. Run Tests:
python -m pytest tests/
  1. Generate Documentation:
sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly_designbuilder
sphinx-build -b html ./docs ./docs/_build/docs