boto3-refresh-session 0.0.7__tar.gz

boto3_refresh_session-0.0.7/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mike Letts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

boto3_refresh_session-0.0.7/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.3
+Name: boto3-refresh-session
+Version: 0.0.7
+Summary: A simple Python package for refreshing boto3 sessions automatically.
+Home-page: https://github.com/michaelthomasletts/boto3-refresh-session
+License: MIT
+Keywords: boto3,botocore,aws
+Author: Mike Letts
+Author-email: michaelthomasletts@gmail.com
+Maintainer: Michael Letts
+Maintainer-email: lettsmt@gmail.com
+Requires-Python: >=3.10
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: attrs (>=24.3.0,<25.0.0)
+Requires-Dist: boto3
+Requires-Dist: botocore
+Project-URL: Repository, https://github.com/michaelthomasletts/boto3-refresh-session
+Description-Content-Type: text/markdown
+
+# boto3-refresh-session
+[![PyPI Download](https://img.shields.io/pypi/v/boto3-refresh-session?logo=pypis.svg)](https://pypi.org/project/boto3-refresh-session/)
+[![Workflow](https://img.shields.io/github/actions/workflow/status/michaelthomasletts/boto3-refresh-session/push_pullrequest.yml?logo=github)](https://github.com/michaelthomasletts/boto3-refresh-session/actions/workflows/push_pullrequest.yml)
+![Python Version](https://img.shields.io/pypi/pyversions/boto3-refresh-session?style=pypi)
+
+## Overview
+
+A simple Python package for refreshing boto3 sessions automatically.
+
+## Features
+- `boto3_refresh_session.AutoRefreshableSession` method for generating an automatically refreshing `boto.Session` object.
+
+## Installation
+
+To install the package using `pip`:
+
+```bash
+$ pip install boto3-refresh-session
+```
+
+Refer to the [boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for configuring credentials on your machine.
+
+## Directory
+
+```
+boto3_refresh_session
+├── __init__.py
+└── session.py
+```
+
+## Usage
+
+Here's how to initialize the `boto3.Client.S3` object:
+
+```python
+from boto3_refresh_session import AutoRefreshableSession
+
+session = AutoRefreshableSession(region="us-east-1", role_arn="<your-arn>", session_name="test")
+s3_client = session.session.client(service_name="s3")
+```
+
+## Contributing
+
+Refer to [this document](https://github.com/michaelthomasletts/boto3-refresh-session/blob/main/docs/contributing.md) for instructions.

boto3_refresh_session-0.0.7/README.md

@@ -0,0 +1,44 @@
+# boto3-refresh-session
+[![PyPI Download](https://img.shields.io/pypi/v/boto3-refresh-session?logo=pypis.svg)](https://pypi.org/project/boto3-refresh-session/)
+[![Workflow](https://img.shields.io/github/actions/workflow/status/michaelthomasletts/boto3-refresh-session/push_pullrequest.yml?logo=github)](https://github.com/michaelthomasletts/boto3-refresh-session/actions/workflows/push_pullrequest.yml)
+![Python Version](https://img.shields.io/pypi/pyversions/boto3-refresh-session?style=pypi)
+
+## Overview
+
+A simple Python package for refreshing boto3 sessions automatically.
+
+## Features
+- `boto3_refresh_session.AutoRefreshableSession` method for generating an automatically refreshing `boto.Session` object.
+
+## Installation
+
+To install the package using `pip`:
+
+```bash
+$ pip install boto3-refresh-session
+```
+
+Refer to the [boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for configuring credentials on your machine.
+
+## Directory
+
+```
+boto3_refresh_session
+├── __init__.py
+└── session.py
+```
+
+## Usage
+
+Here's how to initialize the `boto3.Client.S3` object:
+
+```python
+from boto3_refresh_session import AutoRefreshableSession
+
+session = AutoRefreshableSession(region="us-east-1", role_arn="<your-arn>", session_name="test")
+s3_client = session.session.client(service_name="s3")
+```
+
+## Contributing
+
+Refer to [this document](https://github.com/michaelthomasletts/boto3-refresh-session/blob/main/docs/contributing.md) for instructions.

boto3_refresh_session-0.0.7/boto3_refresh_session/__init__.py

@@ -0,0 +1,6 @@
+__all__ = []
+
+from . import session
+from .session import AutoRefreshableSession
+
+__all__.extend(["session", "AutoRefreshableSession"])

boto3_refresh_session-0.0.7/boto3_refresh_session/session.py

@@ -0,0 +1,117 @@
+from __future__ import annotations
+
+__all__ = ["AutoRefreshableSession"]
+
+from typing import Type
+
+from attrs import define, field
+from attrs.validators import instance_of, le, optional
+from boto3 import Session
+from botocore.credentials import RefreshableCredentials
+from botocore.session import get_session
+
+
+@define
+class AutoRefreshableSession:
+    """Returns a boto3 Session object which refreshes automatically, no extra
+    steps required.
+
+    This object is useful for long-running processes where temporary credentials
+    may expire between iterations.
+
+    To use this class, you must have `~/.aws/config` or `~/.aws/credentials`
+    on your machine.
+
+    Attributes
+    ----------
+    region : str
+        AWS region name.
+    role_arn : str
+        AWS role ARN.
+    session_name : str
+        Name for session.
+    ttl : int, optional
+        Number of seconds until temporary credentials expire, default 900.
+    session_kwargs : dict, optional
+        Optional keyword arguments for `boto3.Session`.
+    client_kwargs : dict, optional
+        Optional keyword arguments for `boto3.Session.client`.
+
+    Other Attributes
+    ----------------
+    session
+        Returns a boto3 Session object with credentials which refresh
+        automatically.
+
+    Notes
+    -----
+    boto3 employs a variety of methods (in order) to identify credentials:
+
+    https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html
+
+    This class assumes that `~/.aws` exists with `/config` or `/credentials`!
+
+    Examples
+    --------
+    Here's how to initialize the `boto3.Client.S3` object:
+
+    >>> from boto3_refresh_session import AutoRefreshableSession
+    >>> session = AutoRefreshableSession(
+    >>>   region="us-east-1",
+    >>>   role_arn="<your-arn>",
+    >>>   session_name="test",
+    >>> )
+    >>> s3_client = session.session.client(service_name="s3")
+    """
+
+    region: str = field(validator=instance_of(str))
+    role_arn: str = field(validator=instance_of(str))
+    session_name: str = field(validator=instance_of(str))
+    ttl: int = field(
+        default=900, validator=optional([instance_of(int), le(900)])
+    )
+    session_kwargs: dict = field(
+        default={}, validator=optional(instance_of(dict))
+    )
+    client_kwargs: dict = field(
+        default={}, validator=optional(instance_of(dict))
+    )
+    session: Type[Session] = field(init=False)
+
+    def __attrs_post_init__(self):
+        __credentials = RefreshableCredentials.create_from_metadata(
+            metadata=self._get_credentials(),
+            refresh_using=self._get_credentials,
+            method="sts-assume-role",
+        )
+        __session = get_session()
+        # https://github.com/boto/botocore/blob/f8a1dd0820b548a5e8dc05420b28b6f1c6e21154/botocore/session.py#L143
+        __session._credentials = __credentials
+        self.session = Session(botocore_session=__session)
+
+    def _get_credentials(self) -> dict:
+        """Returns temporary credentials via AWS STS.
+
+        Returns
+        -------
+        dict
+            AWS temporary credentials.
+        """
+
+        __session = Session(region_name=self.region, **self.session_kwargs)
+        __client = __session.client(
+            service_name="sts", region_name=self.region, **self.client_kwargs
+        )
+        __temporary_credentials = __client.assume_role(
+            RoleArn=self.role_arn,
+            RoleSessionName=self.session_name,
+            DurationSeconds=self.ttl,
+        )["Credentials"]
+        return {
+            "access_key": __temporary_credentials.get("AccessKeyId"),
+            "secret_key": __temporary_credentials.get("SecretAccessKey"),
+            "token": __temporary_credentials.get("SessionToken"),
+            "expiry_time": __temporary_credentials.get(
+                "Expiration"
+            ).isoformat(),
+        }

boto3_refresh_session-0.0.7/pyproject.toml

@@ -0,0 +1,41 @@
+[project]
+name = "boto3-refresh-session"
+version = "0.0.7"
+description = "A simple Python package for refreshing boto3 sessions automatically."
+authors = [
+    {name = "Mike Letts",email = "michaelthomasletts@gmail.com"}
+]
+license = {text = "MIT"}
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = ["boto3", "botocore", "attrs (>=24.3.0,<25.0.0)"]
+keywords = ["boto3", "botocore", "aws"]
+maintainers = [
+  {name="Michael Letts", email="lettsmt@gmail.com"},
+]
+
+[project.urls]
+repository = "https://github.com/michaelthomasletts/boto3-refresh-session"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.4"
+black = "^24.10.0"
+isort = "^5.13.2"
+flake8 = "^7.1.1"
+pre-commit = "^4.0.1"
+
+[tool.black]
+line-length = 79
+target-version = ["py310"]
+verbose = true
+
+[tool.isort]
+line_length = 79
+ensure_newline_before_comments = true
+use_parentheses = true
+include_trailing_comma = true
+multi_line_output = 3