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
Metadata
2 maintainers
Release files for envoy-schema 2.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| envoy_schema-2.7.0.tar.gz | 42.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| envoy_schema-2.7.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 97.1 kB
Release files / envoy_schema-2.7.0.tar.gz
| Download URL | envoy_schema-2.7.0.tar.gz |
|---|---|
| Size | 42.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
32e6274181eff787f14343bd9ecbb1bfa464c1d4e5dde8f631187b4b6a07b6c1
|
|
BLAKE2b-256 checksum How to use checksums |
d124d29a0f4cc6c3b127b162fd7fad9566f3e156e3dda8090ea3ee42c56c0c21
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.13
|
Release files / envoy_schema-2.7.0-py3-none-any.whl
| Download URL | envoy_schema-2.7.0-py3-none-any.whl |
|---|---|
| Size | 54.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ce73d5a7de55741b927246093d4cfc3975b306bfd34a9d9ce3e385f813e19c70
|
|
BLAKE2b-256 checksum How to use checksums |
24f3daed589eed5663caa045d8338f3d2c654d1c9e6b521bc0d9a22e11b6f8df
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.13
|
Security for envoy-schema 2.7.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
