envoy-schema


Nameenvoy-schema JSON
Version 0.14.1 PyPI version JSON
download
home_pageNone
SummaryEnvoy Schema - a collection of pydantic models compatible with the Envoy utility server
upload_time2025-03-12 02:31:38
maintainerNone
docs_urlNone
authorBattery Storage and Grid Integration Program
requires_python>=3.9
licenseNone
keywords envoy csip-aus 2030.5 csip pydantic
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # envoy-schema
Public schema for the models/schema associated all envoy API endpoints.

This repository was built as a shared dependency for the envoy utility server and any external clients wishing to integrate. 

Envoy: https://github.com/bsgip/envoy


## Envoy Server Models

The models served under `envoy_schema.server` are derived from the following standards:

* [IEEE: Smart Energy Profile (2030.5-2018)](https://standards.ieee.org/ieee/2030.5/5897/)
* [Sunspec: Common Smart Inverter Profile](https://sunspec.org/2030-5-csip/)
* [Common Smart Inverter Profile (Australia)](https://csipaus.org/)


## Envoy Admin Models

The models served under `envoy_schema.admin` are typically only used for services directly integrating with the envoy utility server (via the admin server). This is for machine-machine services that are not typically exposed externally.

# Installation

Install directly from pypi

`pip install envoy_schema`


# Development

To install `envoy-schema` for development purposes, after cloning this repository:

```
pip install -e .[dev, test]
pytest
```

We use the following linting/formatting tools:
* [bandit](https://pypi.org/project/black/)
* [flake8](https://pypi.org/project/flake8/)
* [mypy](https://pypi.org/project/mypy/)

Contributions via a pull request are welcome but will be validated using the above tools.

Tests can be run with: `pytest` from the root directory.



            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "envoy-schema",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "envoy, csip-aus, 2030.5, csip, pydantic",
    "author": "Battery Storage and Grid Integration Program",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/65/e1/7c70640e4978925571eb6323f7f8d839c8b8ef8560a72533fb63c61e6701/envoy_schema-0.14.1.tar.gz",
    "platform": null,
    "description": "# envoy-schema\nPublic schema for the models/schema associated all envoy API endpoints.\n\nThis repository was built as a shared dependency for the envoy utility server and any external clients wishing to integrate. \n\nEnvoy: https://github.com/bsgip/envoy\n\n\n## Envoy Server Models\n\nThe models served under `envoy_schema.server` are derived from the following standards:\n\n* [IEEE: Smart Energy Profile (2030.5-2018)](https://standards.ieee.org/ieee/2030.5/5897/)\n* [Sunspec: Common Smart Inverter Profile](https://sunspec.org/2030-5-csip/)\n* [Common Smart Inverter Profile (Australia)](https://csipaus.org/)\n\n\n## Envoy Admin Models\n\nThe models served under `envoy_schema.admin` are typically only used for services directly integrating with the envoy utility server (via the admin server). This is for machine-machine services that are not typically exposed externally.\n\n# Installation\n\nInstall directly from pypi\n\n`pip install envoy_schema`\n\n\n# Development\n\nTo install `envoy-schema` for development purposes, after cloning this repository:\n\n```\npip install -e .[dev, test]\npytest\n```\n\nWe use the following linting/formatting tools:\n* [bandit](https://pypi.org/project/black/)\n* [flake8](https://pypi.org/project/flake8/)\n* [mypy](https://pypi.org/project/mypy/)\n\nContributions via a pull request are welcome but will be validated using the above tools.\n\nTests can be run with: `pytest` from the root directory.\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Envoy Schema - a collection of pydantic models compatible with the Envoy utility server",
    "version": "0.14.1",
    "project_urls": {
        "Homepage": "https://github.com/bsgip/envoy-schema"
    },
    "split_keywords": [
        "envoy",
        " csip-aus",
        " 2030.5",
        " csip",
        " pydantic"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "995cfb85f109c6470a776be6b05baec40c6ad0985832169de3a0cb25748c20d5",
                "md5": "7dbe3da52c4498eb2a785dfd9f1be9e4",
                "sha256": "400613de69e99b6ec1ceb9c1581f7a7e41c3c7c6cadee978175b0bbf07d57144"
            },
            "downloads": -1,
            "filename": "envoy_schema-0.14.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7dbe3da52c4498eb2a785dfd9f1be9e4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 44610,
            "upload_time": "2025-03-12T02:31:36",
            "upload_time_iso_8601": "2025-03-12T02:31:36.901301Z",
            "url": "https://files.pythonhosted.org/packages/99/5c/fb85f109c6470a776be6b05baec40c6ad0985832169de3a0cb25748c20d5/envoy_schema-0.14.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "65e17c70640e4978925571eb6323f7f8d839c8b8ef8560a72533fb63c61e6701",
                "md5": "82a30fa1c7057f5bc78d6501eb7787f4",
                "sha256": "03a161fa6e32123d30a3b96bfd8979f82fef32e24f679c7b4f0502473b9f9013"
            },
            "downloads": -1,
            "filename": "envoy_schema-0.14.1.tar.gz",
            "has_sig": false,
            "md5_digest": "82a30fa1c7057f5bc78d6501eb7787f4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 34341,
            "upload_time": "2025-03-12T02:31:38",
            "upload_time_iso_8601": "2025-03-12T02:31:38.736414Z",
            "url": "https://files.pythonhosted.org/packages/65/e1/7c70640e4978925571eb6323f7f8d839c8b8ef8560a72533fb63c61e6701/envoy_schema-0.14.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-12 02:31:38",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bsgip",
    "github_project": "envoy-schema",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "envoy-schema"
}
        
Elapsed time: 1.18669s