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)
- Sunspec: Common Smart Inverter Profile
- Common Smart Inverter Profile (Australia)
Versioning
The main branch is the active development branch. Releases will be tagged off the associated release branch.
| CSIP-Aus Version | envoy-schema versions | release branches |
|---|---|---|
v1.1a |
v0.*, v1.* |
csipaus.org/ns/v1.2 |
v1.2 |
v0.*, v1.* |
csipaus.org/ns/v1.2 |
v1.3 |
v2.* |
csipaus.org/ns/v1.3 |
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
# Using uv
uv add envoy-schema
# Using pip
pip install envoy-schema
Development
To install envoy-schema for development purposes, after cloning this repository:
# Using uv
uv sync --python 3.13 --all-extras
uv run pytest
# Using pip
pip install -e .[all]
pytest
We use the following linting/formatting tools:
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.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file envoy_schema-2.5.0.tar.gz.
File metadata
- Download URL: envoy_schema-2.5.0.tar.gz
- Upload date:
- Size: 42.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fb288472cbf330501f25e41e8c262f093e01257c2b16c1b64453b35ce498af8f
|
|
| MD5 |
f871ac7f32a61ca090b4703ecebf2035
|
|
| BLAKE2b-256 |
afe091da2204071d86a1c3601f2f1e1e4dde6e49128ccf3b8ba5b3b6083a43c6
|
File details
Details for the file envoy_schema-2.5.0-py3-none-any.whl.
File metadata
- Download URL: envoy_schema-2.5.0-py3-none-any.whl
- Upload date:
- Size: 54.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c158731d61c01622b0b563d2e5696e693f59e728d8ab7635ee87342a41222ffe
|
|
| MD5 |
981eb5b3509b8d6f0cbef88a8c3e7773
|
|
| BLAKE2b-256 |
fe88802232714a6e47ad4c010739c10f1ed3d04266a63c3c326ae1d37de1f57c
|
