boto3-refresh-session 1.3.13__py3-none-any.whl → 1.3.15__py3-none-any.whl

boto3_refresh_session/__init__.py

@@ -4,7 +4,8 @@ from .session import RefreshableSession
 from .sts import STSRefreshableSession
 
 __all__ = ["RefreshableSession"]
-__version__ = "1.3.13"
+__version__ = "1.3.15"
+__title__ = "boto3-refresh-session"
 __author__ = "Mike Letts"
 __maintainer__ = "Mike Letts"
 __license__ = "MIT"

boto3_refresh_session/custom.py

@@ -9,33 +9,36 @@ from .session import BaseRefreshableSession
 
 
 class CustomRefreshableSession(BaseRefreshableSession, method="custom"):
-    """A :class:`boto3.session.Session` object that automatically refreshes temporary credentials
-    returned by a custom credential getter provided by the user. Useful for users with highly
-    sophisticated or idiosyncratic authentication flows.
+    """A :class:`boto3.session.Session` object that automatically refreshes
+    temporary credentials returned by a custom credential getter provided
+    by the user. Useful for users with highly sophisticated or idiosyncratic
+    authentication flows.
 
     Parameters
     ----------
     custom_credentials_method: Callable
-        Required. Accepts a callable object that returns temporary AWS security credentials. That
-        object must return a dictionary containing 'access_key', 'secret_key', 'token', and
-        'expiry_time' when called.
+        Required. Accepts a callable object that returns temporary AWS
+        security credentials. That object must return a dictionary containing
+        'access_key', 'secret_key', 'token', and 'expiry_time' when called.
     custom_credentials_method_args : dict[str, Any], optional
-        Optional keyword arguments for the function passed to the ``custom_credentials_method``
-        parameter.
+        Optional keyword arguments for the function passed to the
+        ``custom_credentials_method`` parameter.
     defer_refresh : bool, optional
-        If ``True`` then temporary credentials are not automatically refreshed until
-        they are explicitly needed. If ``False`` then temporary credentials refresh
-        immediately upon expiration. It is highly recommended that you use ``True``.
-        Default is ``True``.
+        If ``True`` then temporary credentials are not automatically refreshed
+        until they are explicitly needed. If ``False`` then temporary
+        credentials refresh immediately upon expiration. It is highly
+        recommended that you use ``True``. Default is ``True``.
 
     Other Parameters
     ----------------
     kwargs : dict
-        Optional keyword arguments for the :class:`boto3.session.Session` object.
+        Optional keyword arguments for the :class:`boto3.session.Session`
+        object.
 
     Examples
     --------
-    Write (or import) the callable object for obtaining temporary AWS security credentials.
+    Write (or import) the callable object for obtaining temporary AWS security
+    credentials.
 
     >>> def your_custom_credential_getter(your_param, another_param):
     >>>     ...
@@ -85,19 +88,22 @@ class CustomRefreshableSession(BaseRefreshableSession, method="custom"):
 
         if missing := required_keys - credentials.keys():
             raise BRSError(
-                f"The dict returned by custom_credentials_method is missing these key-value pairs: "
+                f"The dict returned by custom_credentials_method is missing "
+                "these key-value pairs: "
                 f"{', '.join(repr(param) for param in missing)}. "
             )
 
         return credentials
 
     def get_identity(self) -> dict[str, str]:
-        """Returns metadata about the custom credential getter.
+        """
+        Returns metadata about the custom credential getter.
 
         Returns
         -------
         dict[str, str]
             Dict containing information about the custom credential getter.
+
         """
 
         source = getattr(

boto3_refresh_session/ecs.py

@@ -22,10 +22,10 @@ class ECSRefreshableSession(BaseRefreshableSession, method="ecs"):
     Parameters
     ----------
     defer_refresh : bool, optional
-        If ``True`` then temporary credentials are not automatically refreshed until
-        they are explicitly needed. If ``False`` then temporary credentials refresh
-        immediately upon expiration. It is highly recommended that you use ``True``.
-        Default is ``True``.
+        If ``True`` then temporary credentials are not automatically
+        refreshed until they are explicitly needed. If ``False`` then
+        temporary credentials refresh immediately upon expiration. It
+        is highly recommended that you use ``True``. Default is ``True``.
 
     Other Parameters
     ----------------

boto3_refresh_session/session.py

@@ -19,7 +19,8 @@ RefreshMethod = Literal["sts-assume-role", "ecs-container-metadata", "custom"]
 
 
 class BaseRefreshableSession(ABC, Session):
-    """Abstract base class for implementing refreshable AWS sessions.
+    """
+    Abstract base class for implementing refreshable AWS sessions.
 
     Provides a common interface and factory registration mechanism
     for subclasses that generate temporary credentials using various
@@ -33,6 +34,7 @@ class BaseRefreshableSession(ABC, Session):
     ----------
     registry : dict[str, type[BaseRefreshableSession]]
         Class-level registry mapping method names to registered session types.
+
     """
 
     # adding this and __init_subclass__ to avoid circular imports
@@ -78,7 +80,8 @@ class BaseRefreshableSession(ABC, Session):
             )
 
     def refreshable_credentials(self) -> dict[str, str]:
-        """The current temporary AWS security credentials.
+        """
+        The current temporary AWS security credentials.
 
         Returns
         -------
@@ -90,6 +93,7 @@ class BaseRefreshableSession(ABC, Session):
                     AWS secret access key.
                 AWS_SESSION_TOKEN : str
                     AWS session token.
+
         """
 
         creds = self.get_credentials().get_frozen_credentials()
@@ -107,32 +111,36 @@ class BaseRefreshableSession(ABC, Session):
 
 
 class RefreshableSession:
-    """Factory class for constructing refreshable boto3 sessions using various authentication
-    methods, e.g. STS.
+    """Factory class for constructing refreshable boto3 sessions using various
+    authentication methods, e.g. STS.
 
-    This class provides a unified interface for creating boto3 sessions whose credentials are
-    automatically refreshed in the background.
+    This class provides a unified interface for creating boto3 sessions whose
+    credentials are automatically refreshed in the background.
 
-    Use ``RefreshableSession(method="...")`` to construct an instance using the desired method.
+    Use ``RefreshableSession(method="...")`` to construct an instance using
+    the desired method.
 
-    For additional information on required parameters, refer to the See Also section below.
+    For additional information on required parameters, refer to the See Also
+    section below.
 
     Parameters
     ----------
     method : Method
-        The authentication and refresh method to use for the session. Must match a registered method name.
-        Default is "sts".
+        The authentication and refresh method to use for the session. Must
+        match a registered method name. Default is "sts".
 
     Other Parameters
     ----------------
     **kwargs : dict
-        Additional keyword arguments forwarded to the constructor of the selected session class.
+        Additional keyword arguments forwarded to the constructor of the
+        selected session class.
 
     See Also
     --------
     boto3_refresh_session.custom.CustomRefreshableSession
     boto3_refresh_session.sts.STSRefreshableSession
     boto3_refresh_session.ecs.ECSRefreshableSession
+
     """
 
     def __new__(
@@ -140,7 +148,8 @@ class RefreshableSession:
     ) -> BaseRefreshableSession:
         if method not in (methods := cls.get_available_methods()):
             raise BRSError(
-                f"{repr(method)} is an invalid method parameter. Available methods are "
+                f"{repr(method)} is an invalid method parameter. "
+                "Available methods are "
                 f"{', '.join(repr(meth) for meth in methods)}."
             )
 
@@ -154,7 +163,8 @@ class RefreshableSession:
         Returns
         -------
         list[str]
-            A list of all currently available credential refresh methods, e.g. 'sts'.
+            A list of all currently available credential refresh methods,
+            e.g. 'sts'.
         """
 
         return list(get_args(Method))

boto3_refresh_session/sts.py

@@ -9,26 +9,29 @@ from .session import BaseRefreshableSession
 
 
 class STSRefreshableSession(BaseRefreshableSession, method="sts"):
-    """A :class:`boto3.session.Session` object that automatically refreshes temporary AWS
-    credentials using an IAM role that is assumed via STS.
+    """A :class:`boto3.session.Session` object that automatically refreshes
+    temporary AWS credentials using an IAM role that is assumed via STS.
 
     Parameters
     ----------
     assume_role_kwargs : dict
-        Required keyword arguments for :meth:`STS.Client.assume_role` (i.e. boto3 STS client).
+        Required keyword arguments for :meth:`STS.Client.assume_role` (i.e.
+        boto3 STS client).
     defer_refresh : bool, optional
-        If ``True`` then temporary credentials are not automatically refreshed until
-        they are explicitly needed. If ``False`` then temporary credentials refresh
-        immediately upon expiration. It is highly recommended that you use ``True``.
-        Default is ``True``.
+        If ``True`` then temporary credentials are not automatically refreshed
+        until they are explicitly needed. If ``False`` then temporary
+        credentials refresh immediately upon expiration. It is highly
+        recommended that you use ``True``. Default is ``True``.
     sts_client_kwargs : dict, optional
-        Optional keyword arguments for the :class:`STS.Client` object. Do not provide
-        values for ``service_name`` as they are unnecessary. Default is None.
+        Optional keyword arguments for the :class:`STS.Client` object. Do not
+        provide values for ``service_name`` as they are unnecessary. Default
+        is None.
 
     Other Parameters
     ----------------
     kwargs : dict
-        Optional keyword arguments for the :class:`boto3.session.Session` object.
+        Optional keyword arguments for the :class:`boto3.session.Session`
+        object.
     """
 
     def __init__(
@@ -43,10 +46,11 @@ class STSRefreshableSession(BaseRefreshableSession, method="sts"):
         self.assume_role_kwargs = assume_role_kwargs
 
         if sts_client_kwargs is not None:
-            # overwriting 'service_name' in case it appears in sts_client_kwargs
+            # overwriting 'service_name' if if appears in sts_client_kwargs
             if "service_name" in sts_client_kwargs:
                 BRSWarning(
-                    "'sts_client_kwargs' cannot contain values for 'service_name'. Reverting to service_name = 'sts'."
+                    "'sts_client_kwargs' cannot contain values for "
+                    "'service_name'. Reverting to service_name = 'sts'."
                 )
                 del sts_client_kwargs["service_name"]
             self._sts_client = self.client(

{boto3_refresh_session-1.3.13.dist-info → boto3_refresh_session-1.3.15.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3-refresh-session
-Version: 1.3.13
+Version: 1.3.15
 Summary: A simple Python package for refreshing the temporary security credentials in a boto3.session.Session object automatically.
 License: MIT
 Keywords: boto3,botocore,aws,sts,ecs,credentials,token,refresh
@@ -78,7 +78,12 @@ Description-Content-Type: text/markdown
 
   <a href="https://medium.com/@lettsmt/you-shouldnt-have-to-think-about-refreshing-aws-credentials-214f7cbbd83b">
     <img src="https://img.shields.io/badge/Medium%20Article-📘-FF0000?style=flat&labelColor=555&logo=readthedocs" alt="Medium Article"/>
-  </a>    
+  </a>
+
+<a href="https://github.com/sponsors/michaelthomasletts">
+  <img src="https://img.shields.io/badge/Sponsor%20this%20Project-💙-FF0000?style=flat&labelColor=555&logo=githubsponsors" alt="Sponsorship"/>
+</a>
+
 
 </div>
 

boto3_refresh_session-1.3.15.dist-info/RECORD

@@ -0,0 +1,11 @@
+boto3_refresh_session/__init__.py,sha256=_4VLYpIvCjuw0X_PUpBwM5vDKWGPpsouzlNkzm0wJKE,364
+boto3_refresh_session/custom.py,sha256=YuorVYEzoYxLkzuoMwSqqAmN0n7ZsXKkS2Q8soAyGkc,3805
+boto3_refresh_session/ecs.py,sha256=2lLMDWEE_JArBf0sRtcFmrzxiIpo_S6dauHS-TDUn4U,3713
+boto3_refresh_session/exceptions.py,sha256=qcFzdIuK5PZirs77H_Kb64S9QFb6cn2OJtirjvaRLiY,972
+boto3_refresh_session/session.py,sha256=mxATkH7rDTCiPtEbqxIkhnl_i7xwHJ0wzTH8Zv-xaL8,5368
+boto3_refresh_session/sts.py,sha256=gJKbslmNl8kR8oAeZfOGmrHtgUUxMm7e9hPgZO678FE,3174
+boto3_refresh_session-1.3.15.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
+boto3_refresh_session-1.3.15.dist-info/METADATA,sha256=s6KkLftJRR6xtmntJt8M2Y_QFVZWOdKdrT3BN9BBHhg,7804
+boto3_refresh_session-1.3.15.dist-info/NOTICE,sha256=1s8r33qbl1z0YvPB942iWgvbkP94P_e8AnROr1qXXuw,939
+boto3_refresh_session-1.3.15.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+boto3_refresh_session-1.3.15.dist-info/RECORD,,

boto3_refresh_session-1.3.13.dist-info/RECORD

@@ -1,11 +0,0 @@
-boto3_refresh_session/__init__.py,sha256=staPg54Ubnm3-Ipi71E4AJQlhf5jRTQlq-BsbVMABRA,328
-boto3_refresh_session/custom.py,sha256=L3kQ_6e-lmIGgm1GHLngOqJOzeS-oDFoVCPTkva0-PA,3760
-boto3_refresh_session/ecs.py,sha256=WIC5mlbcEnM1oo-QXmmtiw2mjFDn01hBfcFh67ku42A,3713
-boto3_refresh_session/exceptions.py,sha256=qcFzdIuK5PZirs77H_Kb64S9QFb6cn2OJtirjvaRLiY,972
-boto3_refresh_session/session.py,sha256=u1gSsYH3OpcbIurMS2nstPbQtOO-S9GZsuk_yhjEqAI,5304
-boto3_refresh_session/sts.py,sha256=paIgbmn9a3cATNX-6AEGxnSGNZnX1pj4rRQmh8gQSKs,3132
-boto3_refresh_session-1.3.13.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
-boto3_refresh_session-1.3.13.dist-info/METADATA,sha256=qP4kzML9CQCS-gSpXlhXwoKh--AffznQorn0ZjfPhvU,7598
-boto3_refresh_session-1.3.13.dist-info/NOTICE,sha256=1s8r33qbl1z0YvPB942iWgvbkP94P_e8AnROr1qXXuw,939
-boto3_refresh_session-1.3.13.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-boto3_refresh_session-1.3.13.dist-info/RECORD,,