envoy-schema 2.4.0

Envoy Schema - a collection of pydantic models compatible with the Envoy utility server

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:

• bandit
• ruff
• ty

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.