Package Health Score

60 / 100

security
Security review needed
popularity
Limited
maintenance
Healthy
community
Limited

Popularity

Limited

GitHub Stars: 17
Forks: 2
Contributors: 2

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package s2-python, we found that it has been starred 17 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Sep 30, 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

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like s2-python 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

Healthy

Commit Frequency

Open Issues: 10
Open PR: 2
Last Release: 2 months ago
Last Commit: 2 months ago

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

We found that s2-python demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

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

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like s2-python 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.10.*, ==3.11.*, ==3.12.*, ==3.8.*, ==3.9.*

Age: 1 year
Latest Release: 10 days ago
Dependencies: 2 Direct / 7 Total
Versions: 8
Maintainers: 1
Wheels: OS Independent

Readme

Python Wrapper for S2 Flexibility Protocol

PyPI - Version

PyPI - Python Version

PyPI - License

This Python package implements the message validation for the EN50491-12-2 "S2" standard for home and building energy management. This implementation is based on the asyncapi description of the protocol provided in the s2-ws-json repository.

Currently, the package supports the common and FILL RATE BASED CONTROL types and messages.

To Install

You can install this package using pip or any Python dependency manager that collects the packages from Pypi:

pip install s2-python

The packages on Pypi may be found here

Mypy support

s2-python uses pydantic at its core to define the various S2 messages. As such, the pydantic mypy plugin is required for type checking to succeed.

Add to your pyproject.toml:

[tool.mypy]
plugins = ['pydantic.mypy']

Example

from s2python.common import PowerRange, CommodityQuantity

# create s2 messages as Python objects
number_range = PowerRange(
    start_of_range=4.0,
    end_of_range=5.0,
    commodity_quantity=CommodityQuantity.ELECTRIC_POWER_L1,
)
# serialize s2 messages
number_range.to_json()
# deserialize s2 messages
json_str = '{"start_of_range": 4.0, "end_of_range": 5.0, "commodity_quantity": "ELECTRIC.POWER.L1"}'
PowerRange.from_json(json_str)

Development

For development, you can install the required dependencies using the following command:

pip install -e .[testing,development]

The tests can be run using tox:

tox

To build the package, you can use tox as well:

tox -e build,clean

s2-python dependencies

click pytz

FAQs

What is s2-python?

S2 Protocol Python Wrapper. Visit Snyk Advisor to see a full health score report for s2-python, including popularity, security, maintenance & community analysis.

Is s2-python popular?

The python package s2-python receives a total of 85 weekly downloads. As such, s2-python popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is s2-python well maintained?

We found that s2-python demonstrated a healthy version release cadence and project activity. It has a community of 2 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is s2-python safe to use?

While scanning the latest version of s2-python, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 18 November-2024, at 12:16 (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

s2-python

S2 Protocol Python Wrapper For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

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

Python Wrapper for S2 Flexibility Protocol

To Install

Mypy support

Example

Development

s2-python dependencies

FAQs

What is s2-python?

Is s2-python popular?

Is s2-python well maintained?

Is s2-python 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

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

Python Wrapper for S2 Flexibility Protocol

To Install

Mypy support

Example

Development

s2-python dependencies

FAQs

What is s2-python?

Is s2-python popular?

Is s2-python well maintained?

Is s2-python 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