boto3-refresh-session 3.0.3__tar.gz → 4.0.0__tar.gz

{boto3_refresh_session-3.0.3 → boto3_refresh_session-4.0.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.3
 Name: boto3-refresh-session
-Version: 3.0.3
+Version: 4.0.0
 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
+Keywords: boto3,botocore,aws,sts,credentials,token,refresh
 Author: Mike Letts
 Author-email: lettsmt@gmail.com
 Maintainer: Michael Letts
@@ -120,13 +120,11 @@ Description-Content-Type: text/markdown
 ## 😛 Features
 
 - Drop-in replacement for `boto3.session.Session`
-- Supports automatic credential refresh methods for various AWS services:
-  - STS
-  - ECS
-- Supports custom authentication methods for complicated authentication flows
+- Supports automatic credential refresh methods for STS
+- Supports custom authentication methods with automatic refresh for complicated authentication flows
 - Natively supports all parameters supported by `boto3.session.Session`
 - [Tested](https://github.com/michaelthomasletts/boto3-refresh-session/tree/main/tests), [documented](https://michaelthomasletts.github.io/boto3-refresh-session/index.html), and [published to PyPI](https://pypi.org/project/boto3-refresh-session/)
-- Future releases will include support for IoT (coming soon), EC2, and SSO
+- Future releases will include support for IoT (coming soon)
 
 ## ⚠️ Important Updates
 
@@ -138,6 +136,10 @@ Advanced users, however, particularly those using low-level objects such as `Bas
 
 Please review [this PR](https://github.com/michaelthomasletts/boto3-refresh-session/pull/75) for additional details.
 
+#### ✂️ v4.0.0
+
+The `ecs` module has been dropped. For additional details and rationale, please review [this PR](https://github.com/michaelthomasletts/boto3-refresh-session/pull/78).
+
 #### ☎️ Delayed Responses
 
 I am currently grappling with a very serious medical condition. Accordingly, expect delayed responses to issues and requests until my health stabilizes.
@@ -171,7 +173,7 @@ pip install boto3-refresh-session
 
   To use the `boto3.client` or `boto3.resource` interface, but with the benefits of `boto3-refresh-session`, you have a few options! 
   
-  In the following examples, let's assume you want to use STS for retrieving temporary credentials for the sake of simplicity. Let's also focus specifically on `client`. Switching to `resource` follows the same exact idioms as below, except that `client` must be switched to `resource` in the pseudo-code, obviously. If you are not sure how to use `RefreshableSession` for STS (or ECS or custom auth flows) then check the usage instructions in the following sections!
+  In the following examples, let's assume you want to use STS for retrieving temporary credentials for the sake of simplicity. Let's also focus specifically on `client`. Switching to `resource` follows the same exact idioms as below, except that `client` must be switched to `resource` in the pseudo-code, obviously. If you are not sure how to use `RefreshableSession` for STS (or custom auth flows) then check the usage instructions in the following sections!
 
   ##### `RefreshableSession.client` (Recommended)
 
@@ -269,24 +271,6 @@ pip install boto3-refresh-session
 
 </details>
 
-<details>
-   <summary><strong>ECS (click to expand)</strong></summary>
-
-  ### ECS
-
-  You can use boto3-refresh-session in an ECS container to automatically refresh temporary security credentials. For additional information on the exact parameters that `RefreshableSession` takes for ECS, [check this documentation](https://github.com/michaelthomasletts/boto3-refresh-session/blob/main/boto3_refresh_session/methods/ecs.py).
-
-  ```python
-  session = RefreshableSession(
-    method="ecs", 
-    region_name=region_name, 
-    profile_name=profile_name,
-    ...
-  )
-  ```
-
-</details>
-
 <details>
    <summary><strong>Custom Authentication Flows (click to expand)</strong></summary>
 

{boto3_refresh_session-3.0.3 → boto3_refresh_session-4.0.0}/README.md

@@ -95,13 +95,11 @@
 ## 😛 Features
 
 - Drop-in replacement for `boto3.session.Session`
-- Supports automatic credential refresh methods for various AWS services:
-  - STS
-  - ECS
-- Supports custom authentication methods for complicated authentication flows
+- Supports automatic credential refresh methods for STS
+- Supports custom authentication methods with automatic refresh for complicated authentication flows
 - Natively supports all parameters supported by `boto3.session.Session`
 - [Tested](https://github.com/michaelthomasletts/boto3-refresh-session/tree/main/tests), [documented](https://michaelthomasletts.github.io/boto3-refresh-session/index.html), and [published to PyPI](https://pypi.org/project/boto3-refresh-session/)
-- Future releases will include support for IoT (coming soon), EC2, and SSO
+- Future releases will include support for IoT (coming soon)
 
 ## ⚠️ Important Updates
 
@@ -113,6 +111,10 @@ Advanced users, however, particularly those using low-level objects such as `Bas
 
 Please review [this PR](https://github.com/michaelthomasletts/boto3-refresh-session/pull/75) for additional details.
 
+#### ✂️ v4.0.0
+
+The `ecs` module has been dropped. For additional details and rationale, please review [this PR](https://github.com/michaelthomasletts/boto3-refresh-session/pull/78).
+
 #### ☎️ Delayed Responses
 
 I am currently grappling with a very serious medical condition. Accordingly, expect delayed responses to issues and requests until my health stabilizes.
@@ -146,7 +148,7 @@ pip install boto3-refresh-session
 
   To use the `boto3.client` or `boto3.resource` interface, but with the benefits of `boto3-refresh-session`, you have a few options! 
   
-  In the following examples, let's assume you want to use STS for retrieving temporary credentials for the sake of simplicity. Let's also focus specifically on `client`. Switching to `resource` follows the same exact idioms as below, except that `client` must be switched to `resource` in the pseudo-code, obviously. If you are not sure how to use `RefreshableSession` for STS (or ECS or custom auth flows) then check the usage instructions in the following sections!
+  In the following examples, let's assume you want to use STS for retrieving temporary credentials for the sake of simplicity. Let's also focus specifically on `client`. Switching to `resource` follows the same exact idioms as below, except that `client` must be switched to `resource` in the pseudo-code, obviously. If you are not sure how to use `RefreshableSession` for STS (or custom auth flows) then check the usage instructions in the following sections!
 
   ##### `RefreshableSession.client` (Recommended)
 
@@ -244,24 +246,6 @@ pip install boto3-refresh-session
 
 </details>
 
-<details>
-   <summary><strong>ECS (click to expand)</strong></summary>
-
-  ### ECS
-
-  You can use boto3-refresh-session in an ECS container to automatically refresh temporary security credentials. For additional information on the exact parameters that `RefreshableSession` takes for ECS, [check this documentation](https://github.com/michaelthomasletts/boto3-refresh-session/blob/main/boto3_refresh_session/methods/ecs.py).
-
-  ```python
-  session = RefreshableSession(
-    method="ecs", 
-    region_name=region_name, 
-    profile_name=profile_name,
-    ...
-  )
-  ```
-
-</details>
-
 <details>
    <summary><strong>Custom Authentication Flows (click to expand)</strong></summary>
 

{boto3_refresh_session-3.0.3 → boto3_refresh_session-4.0.0}/boto3_refresh_session/__init__.py

@@ -3,13 +3,12 @@ __all__ = []
 from . import exceptions, session
 from .exceptions import *
 from .methods.custom import *
-from .methods.ecs import *
 from .methods.sts import *
 from .session import *
 
 __all__.extend(session.__all__)
 __all__.extend(exceptions.__all__)
-__version__ = "3.0.3"
+__version__ = "4.0.0"
 __title__ = "boto3-refresh-session"
 __author__ = "Mike Letts"
 __maintainer__ = "Mike Letts"

{boto3_refresh_session-3.0.3 → boto3_refresh_session-4.0.0}/boto3_refresh_session/methods/__init__.py

@@ -1,12 +1,10 @@
 __all__ = []
 
 # TODO: import iot submodules when finished
-from . import custom, ecs, sts
+from . import custom, sts
 from .custom import CustomRefreshableSession
-from .ecs import ECSRefreshableSession
 from .sts import STSRefreshableSession
 
 # TODO: add iot submodules to __all__ when finished
 __all__.extend(custom.__all__)
-__all__.extend(ecs.__all__)
 __all__.extend(sts.__all__)

{boto3_refresh_session-3.0.3 → boto3_refresh_session-4.0.0}/boto3_refresh_session/session.py

@@ -37,7 +37,6 @@ class RefreshableSession:
     --------
     boto3_refresh_session.methods.custom.CustomRefreshableSession
     boto3_refresh_session.methods.sts.STSRefreshableSession
-    boto3_refresh_session.methods.ecs.ECSRefreshableSession
     """
 
     def __new__(
@@ -60,7 +59,7 @@ class RefreshableSession:
         -------
         list[str]
             A list of all currently available credential refresh methods,
-            e.g. 'sts', 'ecs', 'custom'.
+            e.g. 'sts', 'custom'.
         """
 
         args = list(get_args(Method))

{boto3_refresh_session-3.0.3 → boto3_refresh_session-4.0.0}/boto3_refresh_session/utils/typing.py

@@ -38,7 +38,6 @@ IoTAuthenticationMethod = Literal["certificate", "cognito", "__iot_sentinel__"]
 #: Type alias for all currently available credential refresh methods.
 Method = Literal[
     "sts",
-    "ecs",
     "custom",
     "__sentinel__",
 ]  # TODO: Add iot when implemented
@@ -46,7 +45,6 @@ Method = Literal[
 #: Type alias for all refresh method names.
 RefreshMethod = Literal[
     "sts-assume-role",
-    "ecs-container-metadata",
     "custom",
 ]  # TODO: Add iot-certificate and iot-cognito when iot implemented
 

{boto3_refresh_session-3.0.3 → boto3_refresh_session-4.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "boto3-refresh-session"
-version = "3.0.3"
+version = "4.0.0"
 description = "A simple Python package for refreshing the temporary security credentials in a boto3.session.Session object automatically."
 authors = [
     {name = "Mike Letts",email = "lettsmt@gmail.com"}
@@ -9,7 +9,7 @@ license = {text = "MIT"}
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = ["boto3", "botocore", "requests", "typing-extensions"]
-keywords = ["boto3", "botocore", "aws", "sts", "ecs", "credentials", "token", "refresh"]
+keywords = ["boto3", "botocore", "aws", "sts", "credentials", "token", "refresh"]
 maintainers = [
   {name="Michael Letts", email="lettsmt@gmail.com"},
 ]

boto3_refresh_session-3.0.3/boto3_refresh_session/methods/ecs.py

@@ -1,115 +0,0 @@
-__all__ = ["ECSRefreshableSession"]
-
-import os
-
-import requests
-
-from ..exceptions import BRSError, BRSWarning
-from ..utils import (
-    BaseRefreshableSession,
-    Identity,
-    TemporaryCredentials,
-    refreshable_session,
-)
-
-_ECS_CREDENTIALS_RELATIVE_URI = "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI"
-_ECS_CREDENTIALS_FULL_URI = "AWS_CONTAINER_CREDENTIALS_FULL_URI"
-_ECS_AUTHORIZATION_TOKEN = "AWS_CONTAINER_AUTHORIZATION_TOKEN"
-_DEFAULT_ENDPOINT_BASE = "http://169.254.170.2"
-
-
-@refreshable_session
-class ECSRefreshableSession(BaseRefreshableSession, registry_key="ecs"):
-    """A boto3 session that automatically refreshes temporary AWS credentials
-    from the ECS container credentials metadata endpoint.
-
-    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``.
-
-    Other Parameters
-    ----------------
-    kwargs : dict
-        Optional keyword arguments passed to :class:`boto3.session.Session`.
-    """
-
-    def __init__(self, **kwargs):
-        if "refresh_method" in kwargs:
-            BRSWarning(
-                "'refresh_method' cannot be set manually. "
-                "Reverting to 'ecs-container-metadata'."
-            )
-            del kwargs["refresh_method"]
-
-        # initializing BRSSession
-        super().__init__(refresh_method="ecs-container-metadata", **kwargs)
-
-        # initializing various other attributes
-        self._endpoint = self._resolve_endpoint()
-        self._headers = self._build_headers()
-        self._http = self._init_http_session()
-
-    def _resolve_endpoint(self) -> str:
-        uri = os.environ.get(_ECS_CREDENTIALS_FULL_URI) or os.environ.get(
-            _ECS_CREDENTIALS_RELATIVE_URI
-        )
-        if not uri:
-            raise BRSError(
-                "Neither AWS_CONTAINER_CREDENTIALS_FULL_URI nor "
-                "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is set. "
-                "Are you running inside an ECS container?"
-            )
-        if uri.startswith("http://") or uri.startswith("https://"):
-            return uri
-        return f"{_DEFAULT_ENDPOINT_BASE}{uri}"
-
-    def _build_headers(self) -> dict[str, str]:
-        token = os.environ.get(_ECS_AUTHORIZATION_TOKEN)
-        if token:
-            return {"Authorization": f"Bearer {token}"}
-        return {}
-
-    def _init_http_session(self) -> requests.Session:
-        session = requests.Session()
-        session.headers.update(self._headers)
-        return session
-
-    def _get_credentials(self) -> TemporaryCredentials:
-        try:
-            response = self._http.get(self._endpoint, timeout=3)
-            response.raise_for_status()
-        except requests.RequestException as exc:
-            raise BRSError(
-                f"Failed to retrieve ECS credentials from {self._endpoint}"
-            ) from exc
-
-        credentials = response.json()
-        required = {
-            "AccessKeyId",
-            "SecretAccessKey",
-            "SessionToken",
-            "Expiration",
-        }
-        if not required.issubset(credentials):
-            raise BRSError(f"Incomplete credentials received: {credentials}")
-        return {
-            "access_key": credentials.get("AccessKeyId"),
-            "secret_key": credentials.get("SecretAccessKey"),
-            "token": credentials.get("SessionToken"),
-            "expiry_time": credentials.get("Expiration"),  # already ISO8601
-        }
-
-    def get_identity(self) -> Identity:
-        """Returns metadata about ECS.
-
-        Returns
-        -------
-        Identity
-            Dict containing metadata about ECS.
-        """
-
-        return {"method": "ecs", "source": "ecs-container-metadata"}