boto3-refresh-session 1.3.0__py3-none-any.whl → 1.3.2__py3-none-any.whl

boto3_refresh_session/__init__.py

@@ -3,5 +3,5 @@ from .session import RefreshableSession
 from .sts import STSRefreshableSession
 
 __all__ = ["RefreshableSession"]
-__version__ = "1.3.0"
+__version__ = "1.3.2"
 __author__ = "Mike Letts"

boto3_refresh_session/custom.py

@@ -9,53 +9,49 @@ 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.
-
-    Parameters
-    ----------
-    custom_credentials_method: Callable
-        Required. Accepts a Python function that returns temporary AWS security credentials. That
-        function 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.
-    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``.
-
-    Other Parameters
-    ----------------
-    kwargs : dict
-        Optional keyword arguments for the :class:`boto3.session.Session` object.
-
-    Examples
-    --------
-    Write (or import) the method for obtaining temporary AWS security credentials.
-<<<<<<< feature/custom_get_credentials
-
-=======
-    
->>>>>>> main
-    >>> def your_custom_credential_getter(your_param, another_param):
-    >>>     ...
-    >>>     return {
-    >>>         'access_key': ...,
-    >>>         'secret_key': ...,
-    >>>         'token': ...,
-    >>>         'expiry_time': ...,
-    >>>     }
-
-    Pass that method to ``RefreshableSession``.
-
-    >>> sess = RefreshableSession(
-    >>>     method='custom',
-    >>>     custom_credentials_method=your_custom_credential_getter,
-    >>>     custom_credentials_methods_args=...,
-    >>> )
+        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 Python function that returns temporary AWS security credentials. That
+            function 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.
+        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``.
+
+        Other Parameters
+        ----------------
+        kwargs : dict
+            Optional keyword arguments for the :class:`boto3.session.Session` object.
+
+        Examples
+        --------
+        Write (or import) the method for obtaining temporary AWS security credentials.
+
+        >>> def your_custom_credential_getter(your_param, another_param):
+        >>>     ...
+        >>>     return {
+        >>>         'access_key': ...,
+        >>>         'secret_key': ...,
+        >>>         'token': ...,
+        >>>         'expiry_time': ...,
+        >>>     }
+
+        Pass that method to ``RefreshableSession``.
+
+        >>> sess = RefreshableSession(
+        >>>     method='custom',
+        >>>     custom_credentials_method=your_custom_credential_getter,
+        >>>     custom_credentials_methods_args=...,
+        >>> )
     """
 
     def __init__(

{boto3_refresh_session-1.3.0.dist-info → boto3_refresh_session-1.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3-refresh-session
-Version: 1.3.0
+Version: 1.3.2
 Summary: A simple Python package for refreshing the temporary security credentials in a boto3.session.Session object automatically.
 License: MIT
 Keywords: boto3,botocore,aws

boto3_refresh_session-1.3.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+boto3_refresh_session/__init__.py,sha256=gZg7-ebG3EqS5dwPS-2Hq96bzYS1JOK_hkgwx54dXk8,200
+boto3_refresh_session/custom.py,sha256=i7jVteafmZRIqt1gLbS3VLQhAZ8yn6sp5Hj0dSH4qZk,3377
+boto3_refresh_session/ecs.py,sha256=WIC5mlbcEnM1oo-QXmmtiw2mjFDn01hBfcFh67ku42A,3713
+boto3_refresh_session/exceptions.py,sha256=qcFzdIuK5PZirs77H_Kb64S9QFb6cn2OJtirjvaRLiY,972
+boto3_refresh_session/session.py,sha256=ak8lvgoHMObaJgL4c80ih4bptRHS3ASojnaWdbxn5kA,5246
+boto3_refresh_session/sts.py,sha256=paIgbmn9a3cATNX-6AEGxnSGNZnX1pj4rRQmh8gQSKs,3132
+boto3_refresh_session-1.3.2.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
+boto3_refresh_session-1.3.2.dist-info/METADATA,sha256=e4fDDCOMnX0T33lboeP5OXDCidp_UpZMJXi8oWcpmDY,7898
+boto3_refresh_session-1.3.2.dist-info/NOTICE,sha256=1s8r33qbl1z0YvPB942iWgvbkP94P_e8AnROr1qXXuw,939
+boto3_refresh_session-1.3.2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+boto3_refresh_session-1.3.2.dist-info/RECORD,,

boto3_refresh_session-1.3.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-boto3_refresh_session/__init__.py,sha256=6BxJIN_2xE7AAt7aHPP-ca9La7lPMr0lfGg4F4guY8U,200
-boto3_refresh_session/custom.py,sha256=oBsHpJ2hvVM_IJ0gTqBskWzTrL5__mPqUe_KBXGpTTA,3294
-boto3_refresh_session/ecs.py,sha256=WIC5mlbcEnM1oo-QXmmtiw2mjFDn01hBfcFh67ku42A,3713
-boto3_refresh_session/exceptions.py,sha256=qcFzdIuK5PZirs77H_Kb64S9QFb6cn2OJtirjvaRLiY,972
-boto3_refresh_session/session.py,sha256=ak8lvgoHMObaJgL4c80ih4bptRHS3ASojnaWdbxn5kA,5246
-boto3_refresh_session/sts.py,sha256=paIgbmn9a3cATNX-6AEGxnSGNZnX1pj4rRQmh8gQSKs,3132
-boto3_refresh_session-1.3.0.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
-boto3_refresh_session-1.3.0.dist-info/METADATA,sha256=5dF_ymi5PcKg3fywjz73p3-jZESbyxVa1fj-bhhWYNg,7898
-boto3_refresh_session-1.3.0.dist-info/NOTICE,sha256=1s8r33qbl1z0YvPB942iWgvbkP94P_e8AnROr1qXXuw,939
-boto3_refresh_session-1.3.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-boto3_refresh_session-1.3.0.dist-info/RECORD,,