sgr-commhandler 0.4.dev20250512

SmartGridready CommHandler Library

SmartGridready CommHandler

The commhandler library provides the interfaces and drivers to access devices.

Contents

• Directory Structure
• Build Instructions

Directory Structure

• pyproject.toml is the main project configuration file.
• setup.py is used to build the library package using setuptools.
• requirements.txt contains the dependencies required to use the library.
• requirements-dev.txt contains the dependencies required to run tests.
• src/sgr_commhandler contains the source code of the library, with sgr_commhandler being the root of the namespace.
• tests contains unit and integration tests.
• examples contains basic examples of using the library. See SGrPythonSamples for more detailed examples.

Build Instructions

Prerequisites

Check out the SGrPython repository, e.g. in SGrPython.

Create and activate virtual environment:

cd SGrPython
python -m venv .venv

# On Linux call this:
source ./.venv/bin/activate

# On Windows call this:
.\.venv\Scripts\Activate.ps1

Make sure you have the specification library sgr-specification installed in your virtual environment. See specification for instructions.

Run Tests

You can run tests using pytest while in virtual environment.

It is not necessary to install the package locally, if you only want to run tests.

cd SGrPython/commhandler
pip install -r requirements-dev.txt

pytest

Build and Use Package

Build package and install in virtual environment:

cd SGrPython/commhandler
pip install -e .

You can use the package sgr-commhandler from within the virtual environment now.

Note: The designated package name sgr-commhandler must not be used until the PyPI administrators have approved a SmartGridready organization account!

Clean Up

Deactivate the virtual environment after use:

cd SGrPython
deactivate