boto3-refresh-session 7.1.3__py3-none-any.whl → 7.1.6__py3-none-any.whl

boto3_refresh_session/__init__.py

@@ -13,7 +13,7 @@ from .session import *
 
 __all__.extend(session.__all__)
 __all__.extend(exceptions.__all__)
-__version__ = "7.1.3"
+__version__ = "7.1.6"
 __title__ = "boto3-refresh-session"
 __author__ = "Mike Letts"
 __maintainer__ = "Mike Letts"

boto3_refresh_session/utils/{config/config.py → config.py}

@@ -21,12 +21,12 @@ from typing import Any
 
 from botocore.config import Config
 
-from ...exceptions import BRSValidationError, BRSWarning
-from ..constants import (
+from ..exceptions import BRSValidationError, BRSWarning
+from .constants import (
     ASSUME_ROLE_CONFIG_PARAMETERS,
     STS_CLIENT_CONFIG_PARAMETERS,
 )
-from ..typing import PolicyDescriptorType, ProvidedContext, Tag
+from .typing import PolicyDescriptorType, ProvidedContext, Tag
 
 
 class BaseConfig(dict, ABC):

{boto3_refresh_session-7.1.3.dist-info → boto3_refresh_session-7.1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boto3-refresh-session
-Version: 7.1.3
+Version: 7.1.6
 Summary: A simple Python package for refreshing the temporary security credentials in a boto3.session.Session object automatically.
 License: MPL-2.0
 License-File: LICENSE
@@ -156,73 +156,11 @@ boto3-refresh-session is available on PyPI:
 pip install boto3-refresh-session
 ```
 
-## Quick Start Guide
-
-Basic, bare-bones initialization:
-
-```python
-from boto3_refresh_session import AssumeRoleConfig, RefreshableSession
-
-session = RefreshableSession(
-  AssumeRoleConfig(
-    RoleArn="<your role arn>"
-  )
-)
-```
-
-Basic initilization including some additional session parameters:
-
-```python
-from boto3_refresh_session import AssumeRoleConfig, RefreshableSession
-
-session = RefreshableSession(
-  AssumeRoleConfig(
-    RoleArn="<your role arn>"
-  ),
-  region_name="<your region name>",
-  profile_name="<your aws profile name>",
-)
-```
-
-Slightly advanced initialization using an MFA token provider (Yubikey):
-
-```python
-from boto3_refresh_session import AssumeRoleConfig, RefreshableSession
-import subprocess
-from typing import Sequence
-
-
-def mfa_token_provider(cmd: Sequence[str], timeout: float):
-  p = subprocess.run(
-    list(cmd),
-    check=False,
-    capture_output=True,
-    text=True,
-    timeout=timeout,
-  )
-  return (p.stdout or "").strip()
-
-
-mfa_token_provider_kwargs = {
-  "cmd": ["ykman", "oath", "code", "--single", "AWS-prod"],  # example token source
-  "timeout": 3.0,
-}
-
-session = RefreshableSession(
-  AssumeRoleConfig(
-    RoleArn="<your role arn>",
-    SerialNumber="<your MFA device arn>",
-  ),
-  mfa_token_provider=mfa_token_provider,
-  mfa_token_provider_kwargs=mfa_token_provider_kwargs,
-)
-```
-
 ## Usage
 
-Refer to the [official usage documentation](https://michaelthomasletts.com/boto3-refresh-session/usage.html) for guidance on general usage.
+Refer to the [official usage documentation](https://michaelthomasletts.com/boto3-refresh-session/usage.html) for guidance on how to use boto3-refresh-session.
 
-Refer to the [official API documentation](https://michaelthomasletts.com/boto3-refresh-session/modules/index.html) for technical information.
+Refer to the [official API documentation](https://michaelthomasletts.com/boto3-refresh-session/modules/index.html) for technical information about boto3-refresh-session.
 
 ## Versions
 

{boto3_refresh_session-7.1.3.dist-info → boto3_refresh_session-7.1.6.dist-info}/RECORD

@@ -1,4 +1,4 @@
-boto3_refresh_session/__init__.py,sha256=IdfzDufhNbMK1jCkUvwCIsgYB7-OTkNZeEcWPv8FMUk,620
+boto3_refresh_session/__init__.py,sha256=F4wjqFKsKQMumVe7ovMUKmPV1MQP2k4aDpt0OrvDqE4,620
 boto3_refresh_session/exceptions.py,sha256=ypSr7p5Tf0k_E7cf5r-bl336vofNHGRGXsGdkQTyX58,4412
 boto3_refresh_session/methods/__init__.py,sha256=18a2jb5VvY2FdUhHJ4T1lkfotHpbAb8zdMjqxZ3e6tc,394
 boto3_refresh_session/methods/custom.py,sha256=jHRkleg9wvfJ9P0zsWezAr5-93CbXmVaWd5xYjiynBQ,5346
@@ -9,13 +9,12 @@ boto3_refresh_session/methods/sts.py,sha256=Z8oix37oK0ClHB_YVcsy5H2UCSJObbDbjNW3
 boto3_refresh_session/session.py,sha256=dqcKcC3mknrolpaBv-en67__Xsn0ocJtMF_PCJaim6E,3997
 boto3_refresh_session/utils/__init__.py,sha256=B-bq0LB9XTlP6VjoGLdsIecWxzauULTRQRyEN1YYLfQ,546
 boto3_refresh_session/utils/cache.py,sha256=3zgms7KZSwPMvTnc39ndPqByB7KqpMeZwuV_bv7S6y8,3126
-boto3_refresh_session/utils/config/__init__.py,sha256=AD-dIem6xwiISXEs-xQA8NOhMKibMkBSt00kLpz8JJg,290
-boto3_refresh_session/utils/config/config.py,sha256=gfVHla7dDgrBAt9Prr_UU6WQmA6Y3lWNk6Mg5PL-tKo,9864
+boto3_refresh_session/utils/config.py,sha256=7fOD4ZjtCf4Ssgad83sIbUUmU2dMrinWoYmuprki4Qg,9861
 boto3_refresh_session/utils/constants.py,sha256=iQ6XnSe8p9DH95Ylnhpp6-Pi6amgnBWJSBloHWBK_VA,1132
 boto3_refresh_session/utils/internal.py,sha256=Xvo3D5_MFoldmqNISOmfQf7qydIbQOCVE-0EQY_8pjg,14755
 boto3_refresh_session/utils/typing.py,sha256=pfUP9bGHoh5JlfMBJL-yDBLYykE2gu2A55uLsOS1tVs,3407
-boto3_refresh_session-7.1.3.dist-info/METADATA,sha256=ZJvtmiLo52bygfZHP6HnHVa86ckySU6EbgJcXSmFdCw,8457
-boto3_refresh_session-7.1.3.dist-info/WHEEL,sha256=3ny-bZhpXrU6vSQ1UPG34FoxZBp3lVcvK0LkgUz6VLk,88
-boto3_refresh_session-7.1.3.dist-info/licenses/LICENSE,sha256=hs-WVkefHtuCJFuYX0oswNUDuUV2br7aQmnGCzB2ma4,16725
-boto3_refresh_session-7.1.3.dist-info/licenses/NOTICE,sha256=4nNFSLvbelWrxMEBMrkcmgi93AaF0NckUgNIf9i6Kbs,863
-boto3_refresh_session-7.1.3.dist-info/RECORD,,
+boto3_refresh_session-7.1.6.dist-info/METADATA,sha256=tH2ldzzAAcRW3UlCnXY43axP6O76ibOmhMp06jf1Isc,7172
+boto3_refresh_session-7.1.6.dist-info/WHEEL,sha256=3ny-bZhpXrU6vSQ1UPG34FoxZBp3lVcvK0LkgUz6VLk,88
+boto3_refresh_session-7.1.6.dist-info/licenses/LICENSE,sha256=hs-WVkefHtuCJFuYX0oswNUDuUV2br7aQmnGCzB2ma4,16725
+boto3_refresh_session-7.1.6.dist-info/licenses/NOTICE,sha256=4nNFSLvbelWrxMEBMrkcmgi93AaF0NckUgNIf9i6Kbs,863
+boto3_refresh_session-7.1.6.dist-info/RECORD,,

boto3_refresh_session/utils/config/__init__.py

@@ -1,10 +0,0 @@
-# This Source Code Form is subject to the terms of the Mozilla Public
-# License, v. 2.0. If a copy of the MPL was not distributed with this
-# file, You can obtain one at https://mozilla.org/MPL/2.0/.
-
-__all__ = []
-
-from . import config
-from .config import *
-
-__all__.extend(config.__all__)