[](https://travis-ci.com/ladybug-tools/dragonfly-schema)
[](https://coveralls.io/github/ladybug-tools/dragonfly-schema)
[](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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ladybug-tools/dragonfly-schema",
"name": "dragonfly-schema",
"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/f8/7f/136e2bcb67b110a7536213297c6e914b8890104760afa07ebe32e769f4a5/dragonfly_schema-1.12.6.tar.gz",
"platform": null,
"description": "[](https://travis-ci.com/ladybug-tools/dragonfly-schema)\n[](https://coveralls.io/github/ladybug-tools/dragonfly-schema)\n\n[](https://www.python.org/downloads/release/python-370/)\n\n# dragonfly-schema\n\nDragonfly Data-Model that generates documentation and OpenAPI specifications for\nthe DFJSON file schema.\n\n## Installation\n\n```console\npip install dragonfly-schema\n```\n\n## QuickStart\n\n```python\nimport dragonfly_schema\n\n```\n\n## API Documentation\n\n[Model Schema](https://ladybug-tools.github.io/dragonfly-schema/model.html)\n\n[Energy Simulation Parameter Schema](https://ladybug-tools-in2.github.io/honeybee-schema/simulation-parameter.html)\n\n## Local Development\n\n1. Clone this repo locally\n\n```console\ngit clone git@github.com:ladybug-tools/dragonfly-schema\n\n# or\n\ngit clone https://github.com/ladybug-tools/dragonfly-schema\n```\n\n2. Install dependencies:\n\n```console\ncd dragonfly-schema\npip install -r dev-requirements.txt\npip install -r requirements.txt\n```\n\n3. Run Tests:\n\n```console\npython -m pytest tests/\n```\n\n4. Generate Documentation:\n\n```python\npython ./docs.py\n```\n\n5. Generate Sample Files:\n\n```python\npython ./scripts/export_samples.py\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Dragonfly Data-Model Objects",
"version": "1.12.6",
"project_urls": {
"Homepage": "https://github.com/ladybug-tools/dragonfly-schema"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "06b184c6a99c74340c86e1005a417935d85670114362e91eb1522e280e977d32",
"md5": "6b979474acb5a625dbf859b0cae17845",
"sha256": "f51d6bec61f0d79012f19cdcf79f6fb588aa01aec7956cdac92f805e4e5eabcc"
},
"downloads": -1,
"filename": "dragonfly_schema-1.12.6-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "6b979474acb5a625dbf859b0cae17845",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 18159,
"upload_time": "2024-10-30T23:02:36",
"upload_time_iso_8601": "2024-10-30T23:02:36.002136Z",
"url": "https://files.pythonhosted.org/packages/06/b1/84c6a99c74340c86e1005a417935d85670114362e91eb1522e280e977d32/dragonfly_schema-1.12.6-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f87f136e2bcb67b110a7536213297c6e914b8890104760afa07ebe32e769f4a5",
"md5": "dc9c22653f1f94061b64b62704395ac9",
"sha256": "8a468adf56d14153045f9fd4c8b23be8e840ff52b97693dccd7d1502f3c41a0d"
},
"downloads": -1,
"filename": "dragonfly_schema-1.12.6.tar.gz",
"has_sig": false,
"md5_digest": "dc9c22653f1f94061b64b62704395ac9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 16506,
"upload_time": "2024-10-30T23:02:37",
"upload_time_iso_8601": "2024-10-30T23:02:37.666930Z",
"url": "https://files.pythonhosted.org/packages/f8/7f/136e2bcb67b110a7536213297c6e914b8890104760afa07ebe32e769f4a5/dragonfly_schema-1.12.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 23:02:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ladybug-tools",
"github_project": "dragonfly-schema",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "honeybee-schema",
"specs": [
[
"==",
"1.58.5"
]
]
}
],
"lcname": "dragonfly-schema"
}
JSON
