dragonfly-schema

Name	dragonfly-schema JSON
Version	1.11.1 JSON
	download
home_page	https://github.com/ladybug-tools/dragonfly-schema
Summary	Dragonfly Data-Model Objects
upload_time	2024-04-06 00:13:17
maintainer	None
docs_url	None
author	Ladybug Tools
requires_python	None
license	None
keywords
VCS
bugtrack_url
requirements	honeybee-schema
Travis-CI	No Travis.
coveralls test coverage

            [![Build Status](https://travis-ci.com/ladybug-tools/dragonfly-schema.svg?branch=master)](https://travis-ci.com/ladybug-tools/dragonfly-schema)
[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/dragonfly-schema/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/dragonfly-schema)

[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](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/96/ac/af85da0d2e4501c3258d03c4a58434a17785874d52461fb9ed86ee2b27d3/dragonfly-schema-1.11.1.tar.gz",
    "platform": null,
    "description": "[![Build Status](https://travis-ci.com/ladybug-tools/dragonfly-schema.svg?branch=master)](https://travis-ci.com/ladybug-tools/dragonfly-schema)\n[![Coverage Status](https://coveralls.io/repos/github/ladybug-tools/dragonfly-schema/badge.svg?branch=master)](https://coveralls.io/github/ladybug-tools/dragonfly-schema)\n\n[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](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.11.1",
    "project_urls": {
        "Homepage": "https://github.com/ladybug-tools/dragonfly-schema"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "145ecec2f908c2f3cc3fad1b265081b678cebf28b2d430cacd1ffb804a465cc2",
                "md5": "eaa64347519f1047d8dee58cce2db5d1",
                "sha256": "eaeffb25527c2e8d90ca674ac0afb6c0d6873d88dead9e7ac9d67cd897f561ed"
            },
            "downloads": -1,
            "filename": "dragonfly_schema-1.11.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "eaa64347519f1047d8dee58cce2db5d1",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 17390,
            "upload_time": "2024-04-06T00:13:10",
            "upload_time_iso_8601": "2024-04-06T00:13:10.255244Z",
            "url": "https://files.pythonhosted.org/packages/14/5e/cec2f908c2f3cc3fad1b265081b678cebf28b2d430cacd1ffb804a465cc2/dragonfly_schema-1.11.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "96acaf85da0d2e4501c3258d03c4a58434a17785874d52461fb9ed86ee2b27d3",
                "md5": "54309beef79ecaac3f9887bdbfedacac",
                "sha256": "87b7df4cf227bf474c95ce6b162d546f0bfd85448ae01bfd91128874a31d9aee"
            },
            "downloads": -1,
            "filename": "dragonfly-schema-1.11.1.tar.gz",
            "has_sig": false,
            "md5_digest": "54309beef79ecaac3f9887bdbfedacac",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 81359,
            "upload_time": "2024-04-06T00:13:17",
            "upload_time_iso_8601": "2024-04-06T00:13:17.155470Z",
            "url": "https://files.pythonhosted.org/packages/96/ac/af85da0d2e4501c3258d03c4a58434a17785874d52461fb9ed86ee2b27d3/dragonfly-schema-1.11.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-06 00:13:17",
    "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.57.3"
                ]
            ]
        }
    ],
    "lcname": "dragonfly-schema"
}