wattmaven-solarnetwork-tools 0.4.0

The WattMaven SolarNetwork tools.

wattmaven-solarnetwork-tools

The WattMaven Python package for SolarNetwork tools.

Note that this package is still under active development and the API is not yet stable. Breaking changes will be introduced in the minor version until the API is stable.

Installation

pip install wattmaven-solarnetwork-tools

Usage

See examples for usage examples.

from wattmaven_solarnetwork_tools.core.solarnetwork_client import (
    SolarNetworkClient,
    SolarNetworkCredentials,
)

# Create a client
with SolarNetworkClient(
    host="data.solarnetwork.net",
    credentials=SolarNetworkCredentials(
        token="your_token",
        secret="your_secret",
    )
) as client:
    # Make requests
    response = client.request("GET", "/solarquery/api/v1/sec/nodes")
    json = response.json()
    print(json)
    # ...

Testing

# This will run tests and generate a coverage report
make test

Creating a Release

This project uses Hatch for building and releasing.

# Bump the version
cz bump --major-version-zero

# Build the package
uv build

# Release the package
uv publish

# Push the changes
git push
git push -u origin v<new-version>

Acknowledgements

This project takes inspiration from the solarnetwork-api-core JavaScript package. This package is not a direct port.

License

This project is licensed under the MIT License. See the LICENSE file for details.