boto3-refresh-session 1.0.5__py3-none-any.whl → 1.0.7__py3-none-any.whl

boto3_refresh_session/__init__.py

@@ -4,5 +4,5 @@ from . import session
 from .session import RefreshableSession
 
 __all__.extend(session.__all__)
-__version__ = "1.0.5"
+__version__ = "1.0.7"
 __author__ = "Mike Letts"

boto3_refresh_session/session.py

@@ -7,6 +7,7 @@ credentials.
 __all__ = ["RefreshableSession"]
 
 from typing import Any, Dict
+from warnings import warn
 
 from boto3 import client
 from boto3.session import Session
@@ -30,8 +31,8 @@ class RefreshableSession(Session):
         immediately upon expiration. It is highly recommended that you use ``True``.
         Default is ``True``.
     sts_client_kwargs : dict, optional
-        Optional keyword arguments for the :class:`STS.Client` object. Default is
-        None.
+        Optional keyword arguments for the :class:`STS.Client` object. Do not provide
+        values for ``service_name``. Default is None.
 
     Other Parameters
     ----------------
@@ -109,6 +110,12 @@ class RefreshableSession(Session):
 
         # initializing the STS client
         if sts_client_kwargs is not None:
+            # overwriting 'service_name' in case it appears in sts_client_kwargs
+            if "service_name" in sts_client_kwargs:
+                warn(
+                    "The sts_client_kwargs parameter cannot contain values for service_name. Reverting to service_name = 'sts'."
+                )
+                del sts_client_kwargs["service_name"]
             self._sts_client = client(service_name="sts", **sts_client_kwargs)
         else:
             self._sts_client = client(service_name="sts")

{boto3_refresh_session-1.0.5.dist-info → boto3_refresh_session-1.0.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3-refresh-session
-Version: 1.0.5
+Version: 1.0.7
 Summary: A simple Python package for refreshing the temporary security credentials in a boto3.session.Session object automatically.
 License: MIT
 Keywords: boto3,botocore,aws
@@ -32,71 +32,76 @@ Description-Content-Type: text/markdown
 
 A simple Python package for refreshing the temporary security credentials in a `boto3.session.Session` object automatically.
 
-- [Documentation](https://michaelthomasletts.github.io/boto3-refresh-session/index.html)
+- [Official Documentation](https://michaelthomasletts.github.io/boto3-refresh-session/index.html)
 - [Source Code](https://github.com/michaelthomasletts/boto3-refresh-session)
 - [PyPI](https://pypi.org/project/boto3-refresh-session/)
 - [Contributing](https://michaelthomasletts.github.io/boto3-refresh-session/contributing.html)
+- [Authorization](https://michaelthomasletts.github.io/boto3-refresh-session/authorization.html)
 
-### Why should I use this?
-
-It is common for data pipelines and workflows that interact with the AWS API via 
-`boto3` to run for a long time and, accordingly, for temporary credentials to 
-expire. 
-
-Usually, engineers deal with that problem one of two different ways: 
-
-- A `try except` block that catches `botocore.exceptions.ClientError` exceptions
-- A similar approach as that used in this project -- that is, using methods available 
-  within `botocore` for refreshing temporary credentials automatically. 
-  
-Speaking personally, variations of the code found herein exists in code bases at 
-nearly every company where I have worked. Sometimes, I turned that code into a module; 
-other times, I wrote it from scratch. Clearly, that is inefficient.
-
-I decided to finally turn that code into a proper Python package with unit testing, 
-automatic documentation, and quality checks; the idea being that, henceforth, depending 
-on my employer's open source policy, I may simply import this package instead of 
-reproducing the code herein for the Nth time.
+### Installation
 
-If any of that sounds relatable, then `boto3-refresh-session` should help you!
+```bash
+pip install boto3-refresh-session
+```
 
 ### Usage
 
-Simply pass the basic parameters and initialize the `RefreshableSession` object; 
-that's it! You're good to go!
-
-`RefreshableSession` will refresh
-temporary credentials for you in the background. In the following example,
-continue using the `s3_client` object without worry of using `try` and 
-`except` blocks!
-
-To use this package, your machine must be configured with AWS
-credentials. To learn more about how `boto3` searches for credentials on a
-machine, check [this documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html).
-
 ```python
 import boto3_refresh_session as brs
 
+# you can pass all of the params associated with boto3.session.Session
+profile_name = '<your-profile-name>'
+region_name = 'us-east-1'
+...
+
+# as well as all of the params associated with STS.Client.assume_role
 assume_role_kwargs = {
   'RoleArn': '<your-role-arn>',
   'RoleSessionName': '<your-role-session-name>',
   'DurationSeconds': '<your-selection>',
   ...
 }
+
+# as well as all of the params associated with STS.Client, except for 'service_name'
+sts_client_kwargs = {
+  'region_name': region_name,
+  ...
+}
+
+# basic initialization of boto3.session.Session
 session = brs.RefreshableSession(
-  assume_role_kwargs=assume_role_kwargs
+  assume_role_kwargs=assume_role_kwargs, # required
+  sts_client_kwargs=sts_client_kwargs,
+  region_name=region_name,
+  profile_name=profile_name,
+  ...
 )
+
+# now you can create clients, resources, etc. without worrying about expired temporary 
+# security credentials
 s3 = session.client(service_name='s3')
 buckets = s3.list_buckets()
 ```
 
-### Installation
+### Raison d'être
 
-```bash
-pip install boto3-refresh-session
-```
+It is common for data pipelines and workflows that interact with the AWS API via 
+`boto3` to run for a long time and, accordingly, for temporary credentials to 
+expire. 
+
+Usually, engineers deal with that problem one of two ways: 
 
-### Authors
+- `try except` blocks that catch `ClientError` exceptions
+- A similar approach as that used in this project -- that is, using methods available 
+  within `botocore` for refreshing temporary credentials automatically. 
+  
+Speaking personally, variations of the code found herein exists in code bases at 
+nearly every company where I have worked. Sometimes, I turned that code into a module; 
+other times, I wrote it from scratch. Clearly, that is inefficient.
 
-- [Michael Letts](https://michaelthomasletts.github.io/)
+I decided to finally turn that code into a proper Python package with unit testing, 
+automatic documentation, and quality checks; the idea being that, henceforth, depending 
+on my employer's open source policy, I may simply import this package instead of 
+reproducing the code herein for the Nth time.
 
+If any of that sounds relatable, then `boto3-refresh-session` should help you.

boto3_refresh_session-1.0.7.dist-info/RECORD

@@ -0,0 +1,6 @@
+boto3_refresh_session/__init__.py,sha256=mJmZoHQhXLNiReopzgvH0alWL0kjwNFk1kAumCrKXxo,157
+boto3_refresh_session/session.py,sha256=p4adQ4G2rVm8PPT8xOVV8oMPLS-2h6pSgZNeFd1E1uI,5775
+boto3_refresh_session-1.0.7.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
+boto3_refresh_session-1.0.7.dist-info/METADATA,sha256=s3AXxwUzo2HsFcDqgTsaxGoKstwsXOzdDqXA3aL3Whs,4450
+boto3_refresh_session-1.0.7.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+boto3_refresh_session-1.0.7.dist-info/RECORD,,

boto3_refresh_session-1.0.5.dist-info/RECORD

@@ -1,6 +0,0 @@
-boto3_refresh_session/__init__.py,sha256=fhdmmJvDMjsAMZIl9911pQ4yfIcEKrPsfMd5aPFhOfM,157
-boto3_refresh_session/session.py,sha256=rQHJDvOAz0glymYXQBfSt1keFvQAM_G8AQXgMDLZq2U,5349
-boto3_refresh_session-1.0.5.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
-boto3_refresh_session-1.0.5.dist-info/METADATA,sha256=SkOptv4Q18voBDOooLYjs7VW7Jgsby-6kY8SikHK08U,4395
-boto3_refresh_session-1.0.5.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-boto3_refresh_session-1.0.5.dist-info/RECORD,,