private to public

Author: rakshil14-2

awscrt/__init__.py

@@ -7,6 +7,7 @@
 __all__ = [
     'aio',
     'auth',
+    'aws_iot_metrics',
     'crypto',
     'http',
     'io',

awscrt/_aws_iot_metrics.py awscrt/aws_iot_metrics.pyawscrt/_aws_iot_metrics.py renamed to awscrt/aws_iot_metrics.py

@@ -16,7 +16,7 @@
 from awscrt.io import ClientBootstrap, ClientTlsContext, SocketOptions
 from dataclasses import dataclass
 from awscrt.mqtt5 import Client as Mqtt5Client
-from awscrt._aws_iot_metrics import _create_metrics_mqtt3
+from awscrt.aws_iot_metrics import AWSIoTMetrics, _create_metrics_mqtt3
 
 
 class QoS(IntEnum):
@@ -334,7 +334,7 @@ class Connection(NativeResource):
 
         disable_metrics (bool): Disable IoT SDK metrics in MQTT CONNECT packet username field, including SDK name, version, and platform. Default to False.
 
-        metrics: Optional metrics configuration (AWSIoTMetrics) for IoT SDK metrics reporting. If provided, the CRT will use the given metrics. If None, a default AWSIoTMetrics will be created.
+        metrics (Optional[AWSIoTMetrics]): Optional metrics configuration for IoT SDK metrics reporting. If provided, the CRT will use the given metrics. If None, a default AWSIoTMetrics will be created.
         """
 
     def __init__(self,

awscrt/mqtt.py

@@ -15,7 +15,7 @@
 from dataclasses import dataclass
 from collections.abc import Sequence
 from inspect import signature
-from awscrt._aws_iot_metrics import _create_metrics_mqtt5
+from awscrt.aws_iot_metrics import AWSIoTMetrics, _create_metrics_mqtt5
 
 
 class QoS(IntEnum):
@@ -1372,7 +1372,7 @@ class ClientOptions:
         on_lifecycle_event_connection_failure_fn (Callable[[LifecycleConnectFailureData],]): Callback for Lifecycle Event Connection Failure.
         on_lifecycle_event_disconnection_fn (Callable[[LifecycleDisconnectData],]): Callback for Lifecycle Event Disconnection.
         disable_metrics (bool): Disable IoT SDK metrics in MQTT CONNECT packet username field, including SDK name, version, and platform. Default to False.
-        metrics: Optional metrics configuration (AWSIoTMetrics) for IoT SDK metrics reporting. If provided, the CRT will use the given metrics. If None, a default AWSIoTMetrics will be created.
+        metrics (Optional[AWSIoTMetrics]): Optional metrics configuration for IoT SDK metrics reporting. If provided, the CRT will use the given metrics. If None, a default AWSIoTMetrics will be created.
 
     """
     host_name: str
@@ -1401,7 +1401,7 @@ class ClientOptions:
     on_lifecycle_event_connection_failure_fn: Callable[[LifecycleConnectFailureData], None] = None
     on_lifecycle_event_disconnection_fn: Callable[[LifecycleDisconnectData], None] = None
     disable_metrics: bool = False
-    metrics = None
+    metrics: Optional[AWSIoTMetrics] = None
 
 
 def _check_callback(callback):

awscrt/mqtt5.py

@@ -0,0 +1,5 @@
+awscrt.aws_iot_metrics
+======================
+
+.. automodule:: awscrt.aws_iot_metrics
+    :members:

docsrc/source/api/aws_iot_metrics.rst

@@ -12,6 +12,7 @@ API Reference
    :maxdepth: 2
 
    api/auth
+   api/aws_iot_metrics
    api/checksums
    api/common
    api/crypto

docsrc/source/index.rst

@@ -4,7 +4,7 @@
 import sys
 import unittest
 from test import NativeResourceTest
-from awscrt._aws_iot_metrics import (
+from awscrt.aws_iot_metrics import (
     AWSIoTMetrics,
     IoTMetricsMetadata,
     _MetricsFeatureId,