frequenz-client-common 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- frequenz/client/common/__init__.py +4 -0
- frequenz/client/common/conftest.py +13 -0
- frequenz/client/common/metric/__init__.py +140 -0
- frequenz/client/common/microgrid/__init__.py +4 -0
- frequenz/client/common/microgrid/components/__init__.py +67 -0
- frequenz/client/common/pagination/__init__.py +87 -0
- frequenz/client/common/py.typed +0 -0
- frequenz_client_common-0.1.0.dist-info/LICENSE +21 -0
- frequenz_client_common-0.1.0.dist-info/METADATA +86 -0
- frequenz_client_common-0.1.0.dist-info/RECORD +12 -0
- frequenz_client_common-0.1.0.dist-info/WHEEL +5 -0
- frequenz_client_common-0.1.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# License: MIT
|
|
2
|
+
# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
|
|
3
|
+
|
|
4
|
+
"""Validate docstring code examples.
|
|
5
|
+
|
|
6
|
+
Code examples are often wrapped in triple backticks (```) within docstrings.
|
|
7
|
+
This plugin extracts these code examples and validates them using pylint.
|
|
8
|
+
"""
|
|
9
|
+
|
|
10
|
+
from frequenz.repo.config.pytest import examples
|
|
11
|
+
from sybil import Sybil
|
|
12
|
+
|
|
13
|
+
pytest_collect_file = Sybil(**examples.get_sybil_arguments()).pytest()
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# License: MIT
|
|
2
|
+
# Copyright © 2024 Frequenz Energy-as-a-Service GmbH
|
|
3
|
+
|
|
4
|
+
"""Module to define the metrics used with the common client."""
|
|
5
|
+
|
|
6
|
+
from enum import Enum
|
|
7
|
+
from typing import Self
|
|
8
|
+
|
|
9
|
+
# pylint: disable=no-name-in-module
|
|
10
|
+
from frequenz.api.common.v1.metrics.metric_sample_pb2 import Metric as PBMetric
|
|
11
|
+
|
|
12
|
+
# pylint: enable=no-name-in-module
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
class Metric(Enum):
|
|
16
|
+
"""List of supported metrics."""
|
|
17
|
+
|
|
18
|
+
# Default value
|
|
19
|
+
UNSPECIFIED = PBMetric.METRIC_UNSPECIFIED
|
|
20
|
+
|
|
21
|
+
# DC electricity metrics
|
|
22
|
+
DC_VOLTAGE = PBMetric.METRIC_DC_VOLTAGE
|
|
23
|
+
DC_CURRENT = PBMetric.METRIC_DC_CURRENT
|
|
24
|
+
DC_POWER = PBMetric.METRIC_DC_POWER
|
|
25
|
+
|
|
26
|
+
# General AC electricity metrics
|
|
27
|
+
AC_FREQUENCY = PBMetric.METRIC_AC_FREQUENCY
|
|
28
|
+
AC_VOLTAGE = PBMetric.METRIC_AC_VOLTAGE
|
|
29
|
+
AC_VOLTAGE_PHASE_1 = PBMetric.METRIC_AC_VOLTAGE_PHASE_1
|
|
30
|
+
AC_VOLTAGE_PHASE_2 = PBMetric.METRIC_AC_VOLTAGE_PHASE_2
|
|
31
|
+
AC_VOLTAGE_PHASE_3 = PBMetric.METRIC_AC_VOLTAGE_PHASE_3
|
|
32
|
+
AC_APPARENT_CURRENT = PBMetric.METRIC_AC_APPARENT_CURRENT
|
|
33
|
+
AC_APPARENT_CURRENT_PHASE_1 = PBMetric.METRIC_AC_APPARENT_CURRENT_PHASE_1
|
|
34
|
+
AC_APPARENT_CURRENT_PHASE_2 = PBMetric.METRIC_AC_APPARENT_CURRENT_PHASE_2
|
|
35
|
+
AC_APPARENT_CURRENT_PHASE_3 = PBMetric.METRIC_AC_APPARENT_CURRENT_PHASE_3
|
|
36
|
+
|
|
37
|
+
# AC power metrics
|
|
38
|
+
AC_APPARENT_POWER = PBMetric.METRIC_AC_APPARENT_POWER
|
|
39
|
+
AC_APPARENT_POWER_PHASE_1 = PBMetric.METRIC_AC_APPARENT_POWER_PHASE_1
|
|
40
|
+
AC_APPARENT_POWER_PHASE_2 = PBMetric.METRIC_AC_APPARENT_POWER_PHASE_2
|
|
41
|
+
AC_APPARENT_POWER_PHASE_3 = PBMetric.METRIC_AC_APPARENT_POWER_PHASE_3
|
|
42
|
+
AC_ACTIVE_POWER = PBMetric.METRIC_AC_ACTIVE_POWER
|
|
43
|
+
AC_ACTIVE_POWER_PHASE_1 = PBMetric.METRIC_AC_ACTIVE_POWER_PHASE_1
|
|
44
|
+
AC_ACTIVE_POWER_PHASE_2 = PBMetric.METRIC_AC_ACTIVE_POWER_PHASE_2
|
|
45
|
+
AC_ACTIVE_POWER_PHASE_3 = PBMetric.METRIC_AC_ACTIVE_POWER_PHASE_3
|
|
46
|
+
AC_REACTIVE_POWER = PBMetric.METRIC_AC_REACTIVE_POWER
|
|
47
|
+
AC_REACTIVE_POWER_PHASE_1 = PBMetric.METRIC_AC_REACTIVE_POWER_PHASE_1
|
|
48
|
+
AC_REACTIVE_POWER_PHASE_2 = PBMetric.METRIC_AC_REACTIVE_POWER_PHASE_2
|
|
49
|
+
AC_REACTIVE_POWER_PHASE_3 = PBMetric.METRIC_AC_REACTIVE_POWER_PHASE_3
|
|
50
|
+
|
|
51
|
+
# AC power factor
|
|
52
|
+
AC_POWER_FACTOR = PBMetric.METRIC_AC_POWER_FACTOR
|
|
53
|
+
AC_POWER_FACTOR_PHASE_1 = PBMetric.METRIC_AC_POWER_FACTOR_PHASE_1
|
|
54
|
+
AC_POWER_FACTOR_PHASE_2 = PBMetric.METRIC_AC_POWER_FACTOR_PHASE_2
|
|
55
|
+
AC_POWER_FACTOR_PHASE_3 = PBMetric.METRIC_AC_POWER_FACTOR_PHASE_3
|
|
56
|
+
|
|
57
|
+
# AC energy metrics
|
|
58
|
+
AC_APPARENT_ENERGY = PBMetric.METRIC_AC_APPARENT_ENERGY
|
|
59
|
+
AC_APPARENT_ENERGY_PHASE_1 = PBMetric.METRIC_AC_APPARENT_ENERGY_PHASE_1
|
|
60
|
+
AC_APPARENT_ENERGY_PHASE_2 = PBMetric.METRIC_AC_APPARENT_ENERGY_PHASE_2
|
|
61
|
+
AC_APPARENT_ENERGY_PHASE_3 = PBMetric.METRIC_AC_APPARENT_ENERGY_PHASE_3
|
|
62
|
+
AC_ACTIVE_ENERGY = PBMetric.METRIC_AC_ACTIVE_ENERGY
|
|
63
|
+
AC_ACTIVE_ENERGY_PHASE_1 = PBMetric.METRIC_AC_ACTIVE_ENERGY_PHASE_1
|
|
64
|
+
AC_ACTIVE_ENERGY_PHASE_2 = PBMetric.METRIC_AC_ACTIVE_ENERGY_PHASE_2
|
|
65
|
+
AC_ACTIVE_ENERGY_PHASE_3 = PBMetric.METRIC_AC_ACTIVE_ENERGY_PHASE_3
|
|
66
|
+
AC_ACTIVE_ENERGY_CONSUMED = PBMetric.METRIC_AC_ACTIVE_ENERGY_CONSUMED
|
|
67
|
+
AC_ACTIVE_ENERGY_CONSUMED_PHASE_1 = (
|
|
68
|
+
PBMetric.METRIC_AC_ACTIVE_ENERGY_CONSUMED_PHASE_1
|
|
69
|
+
)
|
|
70
|
+
AC_ACTIVE_ENERGY_CONSUMED_PHASE_2 = (
|
|
71
|
+
PBMetric.METRIC_AC_ACTIVE_ENERGY_CONSUMED_PHASE_2
|
|
72
|
+
)
|
|
73
|
+
AC_ACTIVE_ENERGY_CONSUMED_PHASE_3 = (
|
|
74
|
+
PBMetric.METRIC_AC_ACTIVE_ENERGY_CONSUMED_PHASE_3
|
|
75
|
+
)
|
|
76
|
+
AC_ACTIVE_ENERGY_DELIVERED = PBMetric.METRIC_AC_ACTIVE_ENERGY_DELIVERED
|
|
77
|
+
AC_ACTIVE_ENERGY_DELIVERED_PHASE_1 = (
|
|
78
|
+
PBMetric.METRIC_AC_ACTIVE_ENERGY_DELIVERED_PHASE_1
|
|
79
|
+
)
|
|
80
|
+
AC_ACTIVE_ENERGY_DELIVERED_PHASE_2 = (
|
|
81
|
+
PBMetric.METRIC_AC_ACTIVE_ENERGY_DELIVERED_PHASE_2
|
|
82
|
+
)
|
|
83
|
+
AC_ACTIVE_ENERGY_DELIVERED_PHASE_3 = (
|
|
84
|
+
PBMetric.METRIC_AC_ACTIVE_ENERGY_DELIVERED_PHASE_3
|
|
85
|
+
)
|
|
86
|
+
AC_REACTIVE_ENERGY = PBMetric.METRIC_AC_REACTIVE_ENERGY
|
|
87
|
+
AC_REACTIVE_ENERGY_PHASE_1 = PBMetric.METRIC_AC_REACTIVE_ENERGY_PHASE_1
|
|
88
|
+
AC_REACTIVE_ENERGY_PHASE_2 = PBMetric.METRIC_AC_REACTIVE_ENERGY_PHASE_2
|
|
89
|
+
AC_REACTIVE_ENERGY_PHASE_3 = PBMetric.METRIC_AC_REACTIVE_ENERGY_PHASE_3
|
|
90
|
+
|
|
91
|
+
# AC harmonics
|
|
92
|
+
AC_THD_CURRENT = PBMetric.METRIC_AC_THD_CURRENT
|
|
93
|
+
AC_THD_CURRENT_PHASE_1 = PBMetric.METRIC_AC_THD_CURRENT_PHASE_1
|
|
94
|
+
AC_THD_CURRENT_PHASE_2 = PBMetric.METRIC_AC_THD_CURRENT_PHASE_2
|
|
95
|
+
AC_THD_CURRENT_PHASE_3 = PBMetric.METRIC_AC_THD_CURRENT_PHASE_3
|
|
96
|
+
|
|
97
|
+
# General BMS metrics
|
|
98
|
+
BATTERY_CAPACITY = PBMetric.METRIC_BATTERY_CAPACITY
|
|
99
|
+
BATTERY_SOC_PCT = PBMetric.METRIC_BATTERY_SOC_PCT
|
|
100
|
+
BATTERY_TEMPERATURE = PBMetric.METRIC_BATTERY_TEMPERATURE
|
|
101
|
+
|
|
102
|
+
# General inverter metrics
|
|
103
|
+
INVERTER_TEMPERATURE = PBMetric.METRIC_INVERTER_TEMPERATURE
|
|
104
|
+
INVERTER_TEMPERATURE_CABINET = PBMetric.METRIC_INVERTER_TEMPERATURE_CABINET
|
|
105
|
+
INVERTER_TEMPERATURE_HEATSINK = PBMetric.METRIC_INVERTER_TEMPERATURE_HEATSINK
|
|
106
|
+
INVERTER_TEMPERATURE_TRANSFORMER = PBMetric.METRIC_INVERTER_TEMPERATURE_TRANSFORMER
|
|
107
|
+
|
|
108
|
+
# EV charging station metrics
|
|
109
|
+
EV_CHARGER_TEMPERATURE = PBMetric.METRIC_EV_CHARGER_TEMPERATURE
|
|
110
|
+
|
|
111
|
+
# General sensor metrics
|
|
112
|
+
SENSOR_WIND_SPEED = PBMetric.METRIC_SENSOR_WIND_SPEED
|
|
113
|
+
SENSOR_WIND_DIRECTION = PBMetric.METRIC_SENSOR_WIND_DIRECTION
|
|
114
|
+
SENSOR_TEMPERATURE = PBMetric.METRIC_SENSOR_TEMPERATURE
|
|
115
|
+
SENSOR_RELATIVE_HUMIDITY = PBMetric.METRIC_SENSOR_RELATIVE_HUMIDITY
|
|
116
|
+
SENSOR_DEW_POINT = PBMetric.METRIC_SENSOR_DEW_POINT
|
|
117
|
+
SENSOR_AIR_PRESSURE = PBMetric.METRIC_SENSOR_AIR_PRESSURE
|
|
118
|
+
SENSOR_IRRADIANCE = PBMetric.METRIC_SENSOR_IRRADIANCE
|
|
119
|
+
|
|
120
|
+
@classmethod
|
|
121
|
+
def from_proto(cls, metric: PBMetric.ValueType) -> Self:
|
|
122
|
+
"""Convert a protobuf Metric value to Metric enum.
|
|
123
|
+
|
|
124
|
+
Args:
|
|
125
|
+
metric: Metric to convert.
|
|
126
|
+
Returns:
|
|
127
|
+
Enum value corresponding to the protobuf message.
|
|
128
|
+
"""
|
|
129
|
+
if not any(m.value == metric for m in cls):
|
|
130
|
+
return cls(Metric.UNSPECIFIED)
|
|
131
|
+
|
|
132
|
+
return cls(metric)
|
|
133
|
+
|
|
134
|
+
def to_proto(self) -> PBMetric.ValueType:
|
|
135
|
+
"""Convert a Metric object to protobuf Metric.
|
|
136
|
+
|
|
137
|
+
Returns:
|
|
138
|
+
Protobuf message corresponding to the Metric object.
|
|
139
|
+
"""
|
|
140
|
+
return self.value
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# License: MIT
|
|
2
|
+
# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
|
|
3
|
+
|
|
4
|
+
"""Defines the components that can be used in a microgrid."""
|
|
5
|
+
from __future__ import annotations
|
|
6
|
+
|
|
7
|
+
from enum import Enum
|
|
8
|
+
|
|
9
|
+
# pylint: disable=no-name-in-module
|
|
10
|
+
from frequenz.api.common.v1.microgrid.components.components_pb2 import (
|
|
11
|
+
ComponentCategory as PBComponentCategory,
|
|
12
|
+
)
|
|
13
|
+
|
|
14
|
+
# pylint: enable=no-name-in-module
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
class ComponentCategory(Enum):
|
|
18
|
+
"""Possible types of microgrid component."""
|
|
19
|
+
|
|
20
|
+
UNSPECIFIED = PBComponentCategory.COMPONENT_CATEGORY_UNSPECIFIED
|
|
21
|
+
"""An unknown component category.
|
|
22
|
+
|
|
23
|
+
Useful for error handling, and marking unknown components in
|
|
24
|
+
a list of components with otherwise known categories.
|
|
25
|
+
"""
|
|
26
|
+
|
|
27
|
+
GRID = PBComponentCategory.COMPONENT_CATEGORY_GRID
|
|
28
|
+
"""The point where the local microgrid is connected to the grid."""
|
|
29
|
+
|
|
30
|
+
METER = PBComponentCategory.COMPONENT_CATEGORY_METER
|
|
31
|
+
"""A meter, for measuring electrical metrics, e.g., current, voltage, etc."""
|
|
32
|
+
|
|
33
|
+
INVERTER = PBComponentCategory.COMPONENT_CATEGORY_INVERTER
|
|
34
|
+
"""An electricity generator, with batteries or solar energy."""
|
|
35
|
+
|
|
36
|
+
BATTERY = PBComponentCategory.COMPONENT_CATEGORY_BATTERY
|
|
37
|
+
"""A storage system for electrical energy, used by inverters."""
|
|
38
|
+
|
|
39
|
+
EV_CHARGER = PBComponentCategory.COMPONENT_CATEGORY_EV_CHARGER
|
|
40
|
+
"""A station for charging electrical vehicles."""
|
|
41
|
+
|
|
42
|
+
CHP = PBComponentCategory.COMPONENT_CATEGORY_CHP
|
|
43
|
+
"""A heat and power combustion plant (CHP stands for combined heat and power)."""
|
|
44
|
+
|
|
45
|
+
@classmethod
|
|
46
|
+
def from_proto(
|
|
47
|
+
cls, component_category: PBComponentCategory.ValueType
|
|
48
|
+
) -> ComponentCategory:
|
|
49
|
+
"""Convert a protobuf ComponentCategory message to ComponentCategory enum.
|
|
50
|
+
|
|
51
|
+
Args:
|
|
52
|
+
component_category: protobuf enum to convert
|
|
53
|
+
|
|
54
|
+
Returns:
|
|
55
|
+
Enum value corresponding to the protobuf message.
|
|
56
|
+
"""
|
|
57
|
+
if not any(t.value == component_category for t in ComponentCategory):
|
|
58
|
+
return ComponentCategory.UNSPECIFIED
|
|
59
|
+
return cls(component_category)
|
|
60
|
+
|
|
61
|
+
def to_proto(self) -> PBComponentCategory.ValueType:
|
|
62
|
+
"""Convert a ComponentCategory enum to protobuf ComponentCategory message.
|
|
63
|
+
|
|
64
|
+
Returns:
|
|
65
|
+
Enum value corresponding to the protobuf message.
|
|
66
|
+
"""
|
|
67
|
+
return self.value
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# License: MIT
|
|
2
|
+
# Copyright © 2024 Frequenz Energy-as-a-Service GmbH
|
|
3
|
+
|
|
4
|
+
"""Module to define the pagination used with the common client."""
|
|
5
|
+
|
|
6
|
+
from __future__ import annotations # required for constructor type hinting
|
|
7
|
+
|
|
8
|
+
from dataclasses import dataclass
|
|
9
|
+
from typing import Self
|
|
10
|
+
|
|
11
|
+
# pylint: disable=no-name-in-module
|
|
12
|
+
from frequenz.api.common.v1.pagination.pagination_info_pb2 import PaginationInfo
|
|
13
|
+
from frequenz.api.common.v1.pagination.pagination_params_pb2 import PaginationParams
|
|
14
|
+
|
|
15
|
+
# pylint: enable=no-name-in-module
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
@dataclass(frozen=True, kw_only=True)
|
|
19
|
+
class Params:
|
|
20
|
+
"""Parameters for paginating list requests."""
|
|
21
|
+
|
|
22
|
+
page_size: int | None = None
|
|
23
|
+
"""The maximum number of results to be returned per request."""
|
|
24
|
+
|
|
25
|
+
page_token: str | None = None
|
|
26
|
+
"""The token identifying a specific page of the list results."""
|
|
27
|
+
|
|
28
|
+
@classmethod
|
|
29
|
+
def from_proto(cls, pagination_params: PaginationParams) -> Self:
|
|
30
|
+
"""Convert a protobuf Params to PaginationParams object.
|
|
31
|
+
|
|
32
|
+
Args:
|
|
33
|
+
pagination_params: Params to convert.
|
|
34
|
+
Returns:
|
|
35
|
+
Params object corresponding to the protobuf message.
|
|
36
|
+
"""
|
|
37
|
+
return cls(
|
|
38
|
+
page_size=pagination_params.page_size,
|
|
39
|
+
page_token=pagination_params.page_token,
|
|
40
|
+
)
|
|
41
|
+
|
|
42
|
+
def to_proto(self) -> PaginationParams:
|
|
43
|
+
"""Convert a Params object to protobuf PaginationParams.
|
|
44
|
+
|
|
45
|
+
Returns:
|
|
46
|
+
Protobuf message corresponding to the Params object.
|
|
47
|
+
"""
|
|
48
|
+
return PaginationParams(
|
|
49
|
+
page_size=self.page_size,
|
|
50
|
+
page_token=self.page_token,
|
|
51
|
+
)
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
@dataclass(frozen=True, kw_only=True)
|
|
55
|
+
class Info:
|
|
56
|
+
"""Information about the pagination of a list request."""
|
|
57
|
+
|
|
58
|
+
total_items: int
|
|
59
|
+
"""The total number of items that match the request."""
|
|
60
|
+
|
|
61
|
+
next_page_token: str | None = None
|
|
62
|
+
"""The token identifying the next page of results."""
|
|
63
|
+
|
|
64
|
+
@classmethod
|
|
65
|
+
def from_proto(cls, pagination_info: PaginationInfo) -> Self:
|
|
66
|
+
"""Convert a protobuf PBPaginationInfo to Info object.
|
|
67
|
+
|
|
68
|
+
Args:
|
|
69
|
+
pagination_info: Info to convert.
|
|
70
|
+
Returns:
|
|
71
|
+
Info object corresponding to the protobuf message.
|
|
72
|
+
"""
|
|
73
|
+
return cls(
|
|
74
|
+
total_items=pagination_info.total_items,
|
|
75
|
+
next_page_token=pagination_info.next_page_token,
|
|
76
|
+
)
|
|
77
|
+
|
|
78
|
+
def to_proto(self) -> PaginationInfo:
|
|
79
|
+
"""Convert a Info object to protobuf PBPaginationInfo.
|
|
80
|
+
|
|
81
|
+
Returns:
|
|
82
|
+
Protobuf message corresponding to the Info object.
|
|
83
|
+
"""
|
|
84
|
+
return PaginationInfo(
|
|
85
|
+
total_items=self.total_items,
|
|
86
|
+
next_page_token=self.next_page_token,
|
|
87
|
+
)
|
|
File without changes
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright © 2023 Frequenz Energy-as-a-Service GmbH
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: frequenz-client-common
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Common code and utilities for Frequenz API clients
|
|
5
|
+
Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
|
|
6
|
+
License: MIT
|
|
7
|
+
Project-URL: Documentation, https://frequenz-floss.github.io/frequenz-client-common-python/
|
|
8
|
+
Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-client-common-python/releases
|
|
9
|
+
Project-URL: Issues, https://github.com/frequenz-floss/frequenz-client-common-python/issues
|
|
10
|
+
Project-URL: Repository, https://github.com/frequenz-floss/frequenz-client-common-python
|
|
11
|
+
Project-URL: Support, https://github.com/frequenz-floss/frequenz-client-common-python/discussions/categories/support
|
|
12
|
+
Keywords: frequenz,python,lib,library,client-common
|
|
13
|
+
Classifier: Development Status :: 3 - Alpha
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
18
|
+
Classifier: Topic :: Software Development :: Libraries
|
|
19
|
+
Classifier: Typing :: Typed
|
|
20
|
+
Requires-Python: <4,>=3.11
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE
|
|
23
|
+
Requires-Dist: typing-extensions <5,>=4.5.0
|
|
24
|
+
Requires-Dist: frequenz-api-common <6,>=0.5.4
|
|
25
|
+
Provides-Extra: dev
|
|
26
|
+
Requires-Dist: frequenz-client-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest] ; extra == 'dev'
|
|
27
|
+
Provides-Extra: dev-flake8
|
|
28
|
+
Requires-Dist: flake8 ==7.0.0 ; extra == 'dev-flake8'
|
|
29
|
+
Requires-Dist: flake8-docstrings ==1.7.0 ; extra == 'dev-flake8'
|
|
30
|
+
Requires-Dist: flake8-pyproject ==1.2.3 ; extra == 'dev-flake8'
|
|
31
|
+
Requires-Dist: pydoclint ==0.4.1 ; extra == 'dev-flake8'
|
|
32
|
+
Requires-Dist: pydocstyle ==6.3.0 ; extra == 'dev-flake8'
|
|
33
|
+
Provides-Extra: dev-formatting
|
|
34
|
+
Requires-Dist: black ==24.2.0 ; extra == 'dev-formatting'
|
|
35
|
+
Requires-Dist: isort ==5.13.2 ; extra == 'dev-formatting'
|
|
36
|
+
Provides-Extra: dev-mkdocs
|
|
37
|
+
Requires-Dist: black ==24.2.0 ; extra == 'dev-mkdocs'
|
|
38
|
+
Requires-Dist: Markdown ==3.5.2 ; extra == 'dev-mkdocs'
|
|
39
|
+
Requires-Dist: mike ==2.0.0 ; extra == 'dev-mkdocs'
|
|
40
|
+
Requires-Dist: mkdocs-gen-files ==0.5.0 ; extra == 'dev-mkdocs'
|
|
41
|
+
Requires-Dist: mkdocs-literate-nav ==0.6.1 ; extra == 'dev-mkdocs'
|
|
42
|
+
Requires-Dist: mkdocs-macros-plugin ==1.0.5 ; extra == 'dev-mkdocs'
|
|
43
|
+
Requires-Dist: mkdocs-material ==9.5.12 ; extra == 'dev-mkdocs'
|
|
44
|
+
Requires-Dist: mkdocstrings[python] ==0.24.1 ; extra == 'dev-mkdocs'
|
|
45
|
+
Requires-Dist: frequenz-repo-config[lib] ==0.9.1 ; extra == 'dev-mkdocs'
|
|
46
|
+
Provides-Extra: dev-mypy
|
|
47
|
+
Requires-Dist: mypy ==1.8.0 ; extra == 'dev-mypy'
|
|
48
|
+
Requires-Dist: types-Markdown ==3.5.0.20240129 ; extra == 'dev-mypy'
|
|
49
|
+
Requires-Dist: frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest] ; extra == 'dev-mypy'
|
|
50
|
+
Provides-Extra: dev-noxfile
|
|
51
|
+
Requires-Dist: nox ==2023.4.22 ; extra == 'dev-noxfile'
|
|
52
|
+
Requires-Dist: frequenz-repo-config[lib] ==0.9.1 ; extra == 'dev-noxfile'
|
|
53
|
+
Provides-Extra: dev-pylint
|
|
54
|
+
Requires-Dist: pylint ==3.1.0 ; extra == 'dev-pylint'
|
|
55
|
+
Requires-Dist: frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest] ; extra == 'dev-pylint'
|
|
56
|
+
Provides-Extra: dev-pytest
|
|
57
|
+
Requires-Dist: pytest ==8.1.0 ; extra == 'dev-pytest'
|
|
58
|
+
Requires-Dist: frequenz-repo-config[extra-lint-examples] ==0.9.1 ; extra == 'dev-pytest'
|
|
59
|
+
Requires-Dist: pytest-mock ==3.12.0 ; extra == 'dev-pytest'
|
|
60
|
+
Requires-Dist: pytest-asyncio ==0.23.5 ; extra == 'dev-pytest'
|
|
61
|
+
Requires-Dist: async-solipsism ==0.5 ; extra == 'dev-pytest'
|
|
62
|
+
|
|
63
|
+
# Frequenz Client Common Library
|
|
64
|
+
|
|
65
|
+
[](https://github.com/frequenz-floss/frequenz-client-common-python/actions/workflows/ci.yaml)
|
|
66
|
+
[](https://pypi.org/project/frequenz-client-common/)
|
|
67
|
+
[](https://frequenz-floss.github.io/frequenz-client-common-python/)
|
|
68
|
+
|
|
69
|
+
## Introduction
|
|
70
|
+
|
|
71
|
+
Common code and utilities for Frequenz API clients
|
|
72
|
+
|
|
73
|
+
TODO(cookiecutter): Improve the README file
|
|
74
|
+
|
|
75
|
+
## Supported Platforms
|
|
76
|
+
|
|
77
|
+
The following platforms are officially supported (tested):
|
|
78
|
+
|
|
79
|
+
- **Python:** 3.11
|
|
80
|
+
- **Operating System:** Ubuntu Linux 20.04
|
|
81
|
+
- **Architectures:** amd64, arm64
|
|
82
|
+
|
|
83
|
+
## Contributing
|
|
84
|
+
|
|
85
|
+
If you want to know how to build this project and contribute to it, please
|
|
86
|
+
check out the [Contributing Guide](CONTRIBUTING.md).
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
frequenz/client/common/__init__.py,sha256=77V3FLP0r6asF30IVqsywEQ3-GmE6HSzARBclfaRMno,128
|
|
2
|
+
frequenz/client/common/conftest.py,sha256=NB21GYKVnjam9lHyFyBEYxR8qYjDkvV70f4kuYLzAUY,409
|
|
3
|
+
frequenz/client/common/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
4
|
+
frequenz/client/common/metric/__init__.py,sha256=7fBugvAbiWHX2N9KoGkPj4pNbiTBWDkiUD-Sa8oLL_k,6039
|
|
5
|
+
frequenz/client/common/microgrid/__init__.py,sha256=UApl8BGhb60ecuK-2sLkE7RvRwac4_Sw5LbUChdkciU,107
|
|
6
|
+
frequenz/client/common/microgrid/components/__init__.py,sha256=OzdhOhjtQvfIb8RxDeX8OhiroN20JdHnofOyE-u-0Ho,2300
|
|
7
|
+
frequenz/client/common/pagination/__init__.py,sha256=V51_CREQjZZ0lRSBenoOkLq6o0hiAhC0W4OfnLjdDYY,2665
|
|
8
|
+
frequenz_client_common-0.1.0.dist-info/LICENSE,sha256=C3svrUte2N2h2JaK1qfbYQNp5MTaqdaJkFLe-kgUxbU,1089
|
|
9
|
+
frequenz_client_common-0.1.0.dist-info/METADATA,sha256=cbrRJflYdDqEHHig9jAv-Ju1vsorSSxR-ONKCwRxBQc,4342
|
|
10
|
+
frequenz_client_common-0.1.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
|
|
11
|
+
frequenz_client_common-0.1.0.dist-info/top_level.txt,sha256=x08GRcWytsyKXa2Ayme9e5pg3L5Kcq6lw_BaQmToMO4,9
|
|
12
|
+
frequenz_client_common-0.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
frequenz
|