boto3-refresh-session 1.3.16__tar.gz → 1.3.18__tar.gz

{boto3_refresh_session-1.3.16 → boto3_refresh_session-1.3.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3-refresh-session
-Version: 1.3.16
+Version: 1.3.18
 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
@@ -57,11 +57,11 @@ Description-Content-Type: text/markdown
   </a>
 
   <a href="https://pypistats.org/packages/boto3-refresh-session">
-    <img src="https://img.shields.io/badge/downloads-67.6K-red?logo=python&color=%23FF0000&label=Downloads%20%28with%20mirrors%29" alt="Downloads with mirrors"/>
+    <img src="https://img.shields.io/badge/downloads-72.1K-red?logo=python&color=%23FF0000&label=Downloads%20%28with%20mirrors%29" alt="Downloads with mirrors"/>
   </a>
 
   <a href="https://pypistats.org/packages/boto3-refresh-session">
-    <img src="https://img.shields.io/badge/downloads-17.3K-red?logo=python&color=%23FF0000&label=Downloads%20%28without%20mirrors%29" alt="Downloads without mirrors"/>
+    <img src="https://img.shields.io/badge/downloads-18.1K-red?logo=python&color=%23FF0000&label=Downloads%20%28without%20mirrors%29" alt="Downloads without mirrors"/>
   </a>  
 
   <a href="https://michaelthomasletts.github.io/boto3-refresh-session/index.html">
@@ -118,6 +118,8 @@ pip install boto3-refresh-session
 
 ## Usage (STS)
 
+Most users use AWS STS to assume an IAM role and return a set of temporary security credentials. boto3-refresh-session can be used to ensure those temporary credentials refresh automatically.
+
 ```python
 import boto3_refresh_session as brs
 
@@ -152,6 +154,8 @@ session = brs.RefreshableSession(
 
 ## Usage (ECS)
 
+You can use boto3-refresh-session in an ECS container to automatically refresh temporary security credentials.
+
 ```python
 session = RefreshableSession(
   method="ecs", 

{boto3_refresh_session-1.3.16 → boto3_refresh_session-1.3.18}/README.md

@@ -33,11 +33,11 @@
   </a>
 
   <a href="https://pypistats.org/packages/boto3-refresh-session">
-    <img src="https://img.shields.io/badge/downloads-67.6K-red?logo=python&color=%23FF0000&label=Downloads%20%28with%20mirrors%29" alt="Downloads with mirrors"/>
+    <img src="https://img.shields.io/badge/downloads-72.1K-red?logo=python&color=%23FF0000&label=Downloads%20%28with%20mirrors%29" alt="Downloads with mirrors"/>
   </a>
 
   <a href="https://pypistats.org/packages/boto3-refresh-session">
-    <img src="https://img.shields.io/badge/downloads-17.3K-red?logo=python&color=%23FF0000&label=Downloads%20%28without%20mirrors%29" alt="Downloads without mirrors"/>
+    <img src="https://img.shields.io/badge/downloads-18.1K-red?logo=python&color=%23FF0000&label=Downloads%20%28without%20mirrors%29" alt="Downloads without mirrors"/>
   </a>  
 
   <a href="https://michaelthomasletts.github.io/boto3-refresh-session/index.html">
@@ -94,6 +94,8 @@ pip install boto3-refresh-session
 
 ## Usage (STS)
 
+Most users use AWS STS to assume an IAM role and return a set of temporary security credentials. boto3-refresh-session can be used to ensure those temporary credentials refresh automatically.
+
 ```python
 import boto3_refresh_session as brs
 
@@ -128,6 +130,8 @@ session = brs.RefreshableSession(
 
 ## Usage (ECS)
 
+You can use boto3-refresh-session in an ECS container to automatically refresh temporary security credentials.
+
 ```python
 session = RefreshableSession(
   method="ecs", 

{boto3_refresh_session-1.3.16 → boto3_refresh_session-1.3.18}/boto3_refresh_session/__init__.py

@@ -4,7 +4,7 @@ from .session import RefreshableSession
 from .sts import STSRefreshableSession
 
 __all__ = ["RefreshableSession"]
-__version__ = "1.3.16"
+__version__ = "1.3.18"
 __title__ = "boto3-refresh-session"
 __author__ = "Mike Letts"
 __maintainer__ = "Mike Letts"

{boto3_refresh_session-1.3.16 → boto3_refresh_session-1.3.18}/boto3_refresh_session/custom.py

@@ -5,7 +5,7 @@ __all__ = ["CustomRefreshableSession"]
 from typing import Any, Callable
 
 from .exceptions import BRSError
-from .session import BaseRefreshableSession
+from .session import BaseRefreshableSession, TemporaryCredentials
 
 
 class CustomRefreshableSession(BaseRefreshableSession, method="custom"):
@@ -80,8 +80,8 @@ class CustomRefreshableSession(BaseRefreshableSession, method="custom"):
             refresh_method="custom",
         )
 
-    def _get_credentials(self) -> dict[str, str]:
-        credentials = self._custom_get_credentials(
+    def _get_credentials(self) -> TemporaryCredentials:
+        credentials: TemporaryCredentials = self._custom_get_credentials(
             **self._custom_get_credentials_args
         )
         required_keys = {"access_key", "secret_key", "token", "expiry_time"}

{boto3_refresh_session-1.3.16 → boto3_refresh_session-1.3.18}/boto3_refresh_session/ecs.py

@@ -7,7 +7,7 @@ import os
 import requests
 
 from .exceptions import BRSError
-from .session import BaseRefreshableSession
+from .session import BaseRefreshableSession, TemporaryCredentials
 
 _ECS_CREDENTIALS_RELATIVE_URI = "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI"
 _ECS_CREDENTIALS_FULL_URI = "AWS_CONTAINER_CREDENTIALS_FULL_URI"
@@ -71,7 +71,7 @@ class ECSRefreshableSession(BaseRefreshableSession, method="ecs"):
         session.headers.update(self._headers)
         return session
 
-    def _get_credentials(self) -> dict[str, str]:
+    def _get_credentials(self) -> TemporaryCredentials:
         try:
             response = self._http.get(self._endpoint, timeout=3)
             response.raise_for_status()

{boto3_refresh_session-1.3.16 → boto3_refresh_session-1.3.18}/boto3_refresh_session/session.py

@@ -3,7 +3,8 @@ from __future__ import annotations
 __all__ = ["RefreshableSession"]
 
 from abc import ABC, abstractmethod
-from typing import Any, Callable, ClassVar, Literal, get_args
+from datetime import datetime
+from typing import Any, Callable, ClassVar, Literal, TypedDict, get_args
 
 from boto3.session import Session
 from botocore.credentials import (
@@ -18,6 +19,15 @@ Method = Literal["sts", "ecs", "custom"]
 RefreshMethod = Literal["sts-assume-role", "ecs-container-metadata", "custom"]
 
 
+class TemporaryCredentials(TypedDict):
+    """Temporary IAM credentials."""
+
+    access_key: str
+    secret_key: str
+    token: str
+    expiry_time: datetime | str
+
+
 class BaseRefreshableSession(ABC, Session):
     """Abstract base class for implementing refreshable AWS sessions.
 
@@ -54,7 +64,7 @@ class BaseRefreshableSession(ABC, Session):
         super().__init__(**kwargs)
 
     @abstractmethod
-    def _get_credentials(self) -> dict[str, str]: ...
+    def _get_credentials(self) -> TemporaryCredentials: ...
 
     @abstractmethod
     def get_identity(self) -> dict[str, Any]: ...

{boto3_refresh_session-1.3.16 → boto3_refresh_session-1.3.18}/boto3_refresh_session/sts.py

@@ -5,7 +5,7 @@ __all__ = ["STSRefreshableSession"]
 from typing import Any
 
 from .exceptions import BRSWarning
-from .session import BaseRefreshableSession
+from .session import BaseRefreshableSession, TemporaryCredentials
 
 
 class STSRefreshableSession(BaseRefreshableSession, method="sts"):
@@ -66,7 +66,7 @@ class STSRefreshableSession(BaseRefreshableSession, method="sts"):
             refresh_method="sts-assume-role",
         )
 
-    def _get_credentials(self) -> dict[str, str]:
+    def _get_credentials(self) -> TemporaryCredentials:
         temporary_credentials = self._sts_client.assume_role(
             **self.assume_role_kwargs
         )["Credentials"]

{boto3_refresh_session-1.3.16 → boto3_refresh_session-1.3.18}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "boto3-refresh-session"
-version = "1.3.16"
+version = "1.3.18"
 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"}
@@ -41,7 +41,7 @@ flask = "^3.1.1"
 [tool.black]
 line-length = 79
 target-version = ["py310"]
-verbose = true
+quiet = true
 
 [tool.isort]
 line_length = 79