[](https://github.com/ladybug-tools/dragonfly-display/actions)
[](https://www.python.org/downloads/release/python-370/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)
# dragonfly-display
Adds methods and a CLI to translate dragonfly objects to VisualizationSets.
## Installation
```console
pip install -U dragonfly-display
```
If you want to also include all dependencies needed to produce VTK visualizations
from dragonfly Models use.
```console
pip install -U dragonfly-display[full]
```
To check if the command line interface is installed correctly use `dragonfly-display --help`
## QuickStart
```python
import dragonfly_display
```
## [API Documentation](http://ladybug-tools.github.io/dragonfly-display/docs)
## Local Development
1. Clone this repo locally
```console
git clone git@github.com:ladybug-tools/dragonfly-display
# or
git clone https://github.com/ladybug-tools/dragonfly-display
```
2. Install dependencies:
```console
cd dragonfly-display
pip install -r dev-requirements.txt
pip install -r requirements.txt
```
3. Run Tests:
```console
python -m pytest tests/
```
4. Generate Documentation:
```console
sphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly_display
sphinx-build -b html ./docs ./docs/_build/docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/dragonfly-display",
"name": "dragonfly-display",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Ladybug Tools",
"author_email": "info@ladybug.tools",
"download_url": "https://files.pythonhosted.org/packages/88/06/e73304c0cadb35a25adce50d65ea2dde0cf92c942fb70a76ed46920213cd/dragonfly_display-0.3.5.tar.gz",
"platform": null,
"description": "[](https://github.com/ladybug-tools/dragonfly-display/actions)\n\n[](https://www.python.org/downloads/release/python-370/) [](https://www.python.org/downloads/release/python-270/) [](https://github.com/IronLanguages/ironpython2/releases/tag/ipy-2.7.8/)\n\n# dragonfly-display\n\nAdds methods and a CLI to translate dragonfly objects to VisualizationSets.\n\n## Installation\n\n```console\npip install -U dragonfly-display\n```\n\nIf you want to also include all dependencies needed to produce VTK visualizations\nfrom dragonfly Models use.\n\n```console\npip install -U dragonfly-display[full]\n```\n\nTo check if the command line interface is installed correctly use `dragonfly-display --help`\n\n## QuickStart\n\n```python\nimport dragonfly_display\n\n```\n\n## [API Documentation](http://ladybug-tools.github.io/dragonfly-display/docs)\n\n## Local Development\n\n1. Clone this repo locally\n```console\ngit clone git@github.com:ladybug-tools/dragonfly-display\n\n# or\n\ngit clone https://github.com/ladybug-tools/dragonfly-display\n```\n2. Install dependencies:\n```console\ncd dragonfly-display\npip install -r dev-requirements.txt\npip install -r requirements.txt\n```\n\n3. Run Tests:\n```console\npython -m pytest tests/\n```\n\n4. Generate Documentation:\n```console\nsphinx-apidoc -f -e -d 4 -o ./docs ./dragonfly_display\nsphinx-build -b html ./docs ./docs/_build/docs\n```\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Adds methods to translate dragonfly objects to VisualizationSets.",
"version": "0.3.5",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/dragonfly-display"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a3b0a983fa001a1ffbb9d1c158b0ef0469f19a8764fc7e446a052bdebada1e82",
"md5": "ed1be4329f67f43a8c90c3a9ac18845a",
"sha256": "a1b8c0973d76e07b0a20d4194e7cce53fcfeb6c58be57d22c8e092797b2a9107"
},
"downloads": -1,
"filename": "dragonfly_display-0.3.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ed1be4329f67f43a8c90c3a9ac18845a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 22226,
"upload_time": "2025-02-24T19:39:30",
"upload_time_iso_8601": "2025-02-24T19:39:30.392834Z",
"url": "https://files.pythonhosted.org/packages/a3/b0/a983fa001a1ffbb9d1c158b0ef0469f19a8764fc7e446a052bdebada1e82/dragonfly_display-0.3.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8806e73304c0cadb35a25adce50d65ea2dde0cf92c942fb70a76ed46920213cd",
"md5": "bdcf747bed83c3afcf27e78c74d71a55",
"sha256": "5b123f64221af87cc4b22376625ce3b8ea4a6a6c25ad50f0a5b590235d132b5f"
},
"downloads": -1,
"filename": "dragonfly_display-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "bdcf747bed83c3afcf27e78c74d71a55",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 22179,
"upload_time": "2025-02-24T19:39:32",
"upload_time_iso_8601": "2025-02-24T19:39:32.159561Z",
"url": "https://files.pythonhosted.org/packages/88/06/e73304c0cadb35a25adce50d65ea2dde0cf92c942fb70a76ed46920213cd/dragonfly_display-0.3.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-24 19:39:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "dragonfly-display",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "honeybee-display",
"specs": [
[
">=",
"0.5.3"
]
]
},
{
"name": "dragonfly-core",
"specs": [
[
">=",
"1.59.1"
]
]
}
],
"lcname": "dragonfly-display"
}
JSON
