[](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/61/99/a03d11b318c8b2f594df824470cba535e2d29f59ff14a41f0bbdeeba2689/dragonfly-display-0.1.0.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.1.0",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/dragonfly-display"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "78c4704c5faf145e4eac97b6eae2efc5095029037f93407d0fcb9afe0aca4553",
"md5": "c3d5607dfaba67e12c543d743cc13993",
"sha256": "338ceb87093ca688e5c9f66cf443ad27b597bf8f0aecba7d2e0063a0fc7c3555"
},
"downloads": -1,
"filename": "dragonfly_display-0.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "c3d5607dfaba67e12c543d743cc13993",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 19935,
"upload_time": "2024-03-20T18:49:35",
"upload_time_iso_8601": "2024-03-20T18:49:35.310753Z",
"url": "https://files.pythonhosted.org/packages/78/c4/704c5faf145e4eac97b6eae2efc5095029037f93407d0fcb9afe0aca4553/dragonfly_display-0.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6199a03d11b318c8b2f594df824470cba535e2d29f59ff14a41f0bbdeeba2689",
"md5": "ef39f301cdf3340efc7cf09966a8f6b1",
"sha256": "9a3f471f5e8d678e62d8df2bec05ffc0ae59bcb65a1510472d45253d2ee9bf6a"
},
"downloads": -1,
"filename": "dragonfly-display-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ef39f301cdf3340efc7cf09966a8f6b1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 43866,
"upload_time": "2024-03-20T18:49:37",
"upload_time_iso_8601": "2024-03-20T18:49:37.171119Z",
"url": "https://files.pythonhosted.org/packages/61/99/a03d11b318c8b2f594df824470cba535e2d29f59ff14a41f0bbdeeba2689/dragonfly-display-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-20 18:49:37",
"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.3.6"
]
]
},
{
"name": "dragonfly-core",
"specs": [
[
">=",
"1.42.18"
]
]
}
],
"lcname": "dragonfly-display"
}
JSON
