# 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/4b/fa/4e924081a0ce2f37a0fcccfc3a8adbea51de18f42da8cc52972cf17e8480/envoy_schema-0.26.0.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.26.0",
"project_urls": {
"Homepage": "https://github.com/bsgip/envoy-schema"
},
"split_keywords": [
"envoy",
" csip-aus",
" 2030.5",
" csip",
" pydantic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "460c690c410253f1e7bd837b6f1e9c456c0fe9cd4b0d329673589318eb385183",
"md5": "c4231b3641c8d12c161c7d455d9175d2",
"sha256": "927a5358618d89ffe351a42e4364da2acbf982354fcf808ea1b555f216c5ad37"
},
"downloads": -1,
"filename": "envoy_schema-0.26.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c4231b3641c8d12c161c7d455d9175d2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 52895,
"upload_time": "2025-08-28T23:46:10",
"upload_time_iso_8601": "2025-08-28T23:46:10.610176Z",
"url": "https://files.pythonhosted.org/packages/46/0c/690c410253f1e7bd837b6f1e9c456c0fe9cd4b0d329673589318eb385183/envoy_schema-0.26.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4bfa4e924081a0ce2f37a0fcccfc3a8adbea51de18f42da8cc52972cf17e8480",
"md5": "7b358bf46b96b766b4b53668243a9a83",
"sha256": "246b851bb6ebed5bd40aeaa9ee299b4348dc5dff6507971259c67d79733543e6"
},
"downloads": -1,
"filename": "envoy_schema-0.26.0.tar.gz",
"has_sig": false,
"md5_digest": "7b358bf46b96b766b4b53668243a9a83",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 40184,
"upload_time": "2025-08-28T23:46:12",
"upload_time_iso_8601": "2025-08-28T23:46:12.200763Z",
"url": "https://files.pythonhosted.org/packages/4b/fa/4e924081a0ce2f37a0fcccfc3a8adbea51de18f42da8cc52972cf17e8480/envoy_schema-0.26.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-28 23:46:12",
"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"
}
JSON
