Package Health Score

72 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Popularity

Small

GitHub Stars: 102
Forks: 61
Contributors: 30

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package solax, we found that it has been starred 102 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Jun 5, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like solax is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 34
Open PR: 13
Last Release: 5 months ago
Last Commit: 2 months ago

Further analysis of the maintenance status of solax based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that solax demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 30
Funding: No

With more than 10 contributors for the solax repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like solax is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8

Age: 6 years
Latest Release: 5 months ago
Dependencies: 0 Direct
Versions: 26
Maintainers: 1
Wheels: OS Independent

Readme

Solax

Read energy usage data from the real-time API on Solax solar inverters.

Real time power, current and voltage
Grid power information
Battery level
Temperature and inverter health
Daily/Total energy summaries

Usage

pip install solax

Then from within your project:

import solax
import asyncio

async def work():
    r = await solax.real_time_api('10.0.0.1')
    return await r.get_data()

loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
data = loop.run_until_complete(work())
print(data)

This will try all the inverter classes in turn until it finds the first one that works with your installation. You can see the list of inverter implementation classes in the entry points configured in setup.py.

If you want to bypass the inverter discovery code and use a specific inverter class, you can invoke discover specifying directly the class. In this example, the X1 Hybrid Gen4 implementation is used:

from importlib.metadata import entry_points
import solax
import asyncio

INVERTERS_ENTRY_POINTS = {
   ep.name: ep.load() for ep in entry_points(group="solax.inverter")
}

async def work():
    inverter = await solax.discover("10.0.0.1", 80, "xxxxx", inverters=[INVERTERS_ENTRY_POINTS.get("x1_hybrid_gen4")], return_when=asyncio.FIRST_COMPLETED)
    return await inverter.get_data()

loop = asyncio.new_event_loop()
asyncio.set_event_loop(loop)
data = loop.run_until_complete(work())
print(data)

Confirmed Supported Inverters

These inverters have been tested and confirmed to be working. If your inverter is not listed below, this library may still work- please create an issue so we can add your inverter to the list 😊.

SK-TL5000E
X1 Hybrid Gen4

You can get the list of supported inverters by looking up the solax.inverter entry points:

for ep in entry_points(group="solax.inverter"):
    print(ep)

FAQs

What is solax?

Solax inverter API client. Visit Snyk Advisor to see a full health score report for solax, including popularity, security, maintenance & community analysis.

Is solax popular?

The python package solax receives a total of 2,025 weekly downloads. As such, solax popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is solax well maintained?

We found indications that solax maintenance is sustainable demonstrating some project activity. We saw a total of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is solax safe to use?

The python package solax was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 4 November-2024, at 09:17 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

solax

Solax inverter API client For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Explore Similar Packages

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

Solax

Usage

Confirmed Supported Inverters

FAQs

What is solax?

Is solax popular?

Is solax well maintained?

Is solax safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Solax

Usage

Confirmed Supported Inverters

FAQs

What is solax?

Is solax popular?

Is solax well maintained?

Is solax safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues