[major] Dropping the boto3_refresh_session.ecs module (#78)

* [major] Deprecating ecs module Currently, automatic credential refresh is handled already by ECS / boto. The intended purpose of the ECS module was for local testing or to accommodate bespoke endpoints by modulating the constants in `ecs.py`. However, it is far easier for users to instead use `custom.py`. This makes sense. Users with complicated authentication flows are more likely to find value from the custom module. This also reduces the overall complexity of boto3-refresh-session, which is attractive for users. Hence, I have decided to drop the ECS module, as it appears superfluous when the custom module does what users want far better and simpler. * readme update

Author: michaelthomasletts

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/__init__.py

@@ -3,7 +3,6 @@
 from . import exceptions, session
 from .exceptions import *
 from .methods.custom import *
-from .methods.ecs import *
 from .methods.sts import *
 from .session import *
 

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/methods/ecs.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 @@ def get_available_methods(cls) -> list[str]:
  -------
  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/session.py

@@ -38,15 +38,13 @@
 #: Type alias for all currently available credential refresh methods.
 Method = Literal[
  "sts",
- "ecs",
  "custom",
  "__sentinel__",
 ] # TODO: Add iot when implemented
 
 #: 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/utils/typing.py

@@ -18,7 +18,6 @@ boto3-refresh-session includes multiple modules, grouped into two categories:
  session
  custom
  sts
- ecs
 
 Core interface
 --------------
@@ -28,7 +27,7 @@ The :class:`boto3_refresh_session.session.RefreshableSession` class provides a u
 
 .. tip::
 
- For most users, STS is sufficient — there’s no need to manually specify the ``method`` parameter unless using advanced strategies like ECS.
+ For most users, STS is sufficient — there’s no need to manually specify the ``method`` parameter unless using advanced strategies like ``custom``.
  All users should, however, familiarize themselves with the documentation in the Refresh strategies in order to understand required and optional parameters and available methods.
 
 - :ref:`session` — Factory interface for creating refreshable boto3 sessions
@@ -49,7 +48,6 @@ Each strategy supported by boto3-refresh-session is encapsulated in its own modu
 
 - :ref:`custom` - Refresh strategy using a custom credential refresh strategy
 - :ref:`sts` — Refresh strategy using :class:`STS.Client`
-- :ref:`ecs` - Refresh strategy using AWS ECS container metadata
 
 Exceptions and Warnings
 -----------------------

doc/modules/ecs.rst

@@ -25,7 +25,6 @@ Examples
 
 .. seealso::
  :class:`boto3_refresh_session.methods.custom.CustomRefreshableSession`
- :class:`boto3_refresh_session.methods.ecs.ECSRefreshableSession`
  :class:`boto3_refresh_session.methods.sts.STSRefreshableSession`
 
 Factory interface