boto3-refresh-session 0.0.18__py3-none-any.whl → 0.0.21__py3-none-any.whl

boto3_refresh_session/session.py

@@ -1,19 +1,20 @@
 from __future__ import annotations
 
 __doc__ = """
-Helper method for generating an automatically refreshing ``boto3.Session``
+Helper method for generating an automatically refreshing :class:`boto3.session.Session`
 object.
 
 .. warning::
     ``AutoRefreshableSession`` was not tested for manually passing hard-coded
-    account credentials to the ``boto3.Session`` or ``boto3.Session.client`` 
+    account credentials to the :class:`boto3.session.Session` or ``boto3.client`` 
     objects! There are optional ``session_kwargs`` and ``client_kwargs``
     parameters available for passing hard-coded account credentials, which
     should work; however, that cannot be guaranteed! In any case, the ``boto3``
-    documentation strongly urges against passing hard-coded account credentials
+    documentation generally recommends against passing hard-coded account credentials
     as parameters; it is for that reason the documentation below, and everywhere
     else, only mentions ``~/.aws/config`` and ``~/.aws/credentials`` for 
-    authorization.
+    authorization. Since the ``session_kwargs`` and ``client_kwargs`` parameters 
+    were not tested, you will need to use those parameters at your own discretion.
 """
 __all__ = ["AutoRefreshableSession"]
 
@@ -28,14 +29,11 @@ from botocore.session import get_session
 
 @define
 class AutoRefreshableSession:
-    """Returns a ``boto3.Session`` object which refreshes automatically, no extra
+    """Returns a :class:`boto3.session.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``
-    configured on your machine.
+    may expire.
 
     Parameters
     ----------
@@ -48,27 +46,24 @@ class AutoRefreshableSession:
     ttl : int, optional
         Number of seconds until temporary credentials expire, default 900.
     session_kwargs : dict, optional
-        Optional keyword arguments for ``boto3.Session``.
+        Optional keyword arguments for :class:`boto3.session.Session`.
     client_kwargs : dict, optional
-        Optional keyword arguments for ``boto3.Session.client``.
+        Optional keyword arguments for ``boto3.client``.
 
     Attributes
     ----------
     session
-        Returns a ``boto3.Session`` object with credentials which refresh
+        Returns a :class:`boto3.session.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``!
+    Check the :ref:`authorization documentation <authorization>` for additional
+    information concerning how to authorize access to AWS.
 
     Examples
     --------
-    Here's how to initialize the ``boto3.Client.S3`` object:
+    Here's how to initialize this object:
 
     >>> sess = AutoRefreshableSession(
     >>>   region="us-east-1",

{boto3_refresh_session-0.0.18.dist-info → boto3_refresh_session-0.0.21.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3-refresh-session
-Version: 0.0.18
+Version: 0.0.21
 Summary: A simple Python package for refreshing boto3 sessions automatically.
 Home-page: https://github.com/michaelthomasletts/boto3-refresh-session
 License: MIT
@@ -73,7 +73,10 @@ 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
+from boto3_refresh_session import AutoRefreshableSession
+
+
 sess = AutoRefreshableSession(
     region="<your-region>",
     role_arn="<your-role-arn>",
@@ -82,6 +85,12 @@ sess = AutoRefreshableSession(
 s3_client = sess.session.client(service_name="s3")
 ```
 
+### Installation
+
+```bash
+pip install boto3-refresh-session
+```
+
 ### Authors
 
 - [Michael Letts](https://michaelthomasletts.github.io/)

boto3_refresh_session-0.0.21.dist-info/RECORD

@@ -0,0 +1,6 @@
+boto3_refresh_session/__init__.py,sha256=OMY8el4qROyEvo0vr1Kv8rtFU7g3xnjHuBss54XRTEA,135
+boto3_refresh_session/session.py,sha256=3bzw-zs_5TXmJsFJSSV8ENpPK3XrItvCuU2otVKn8X8,4489
+boto3_refresh_session-0.0.21.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
+boto3_refresh_session-0.0.21.dist-info/METADATA,sha256=eNGmHlSIeXhl-tO5vyu33VaHXbXKm9WduO8S8KrhHmQ,4007
+boto3_refresh_session-0.0.21.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
+boto3_refresh_session-0.0.21.dist-info/RECORD,,

boto3_refresh_session-0.0.18.dist-info/RECORD

@@ -1,6 +0,0 @@
-boto3_refresh_session/__init__.py,sha256=OMY8el4qROyEvo0vr1Kv8rtFU7g3xnjHuBss54XRTEA,135
-boto3_refresh_session/session.py,sha256=KeaQ7kfIZtJqF5rdZNJu7ASvxWX03oRDwjFyw82haeA,4545
-boto3_refresh_session-0.0.18.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
-boto3_refresh_session-0.0.18.dist-info/METADATA,sha256=hZHbtCX66fKIlAc-zc60DN7Q4Mt4Ws4o2lZw5LA1uZo,3877
-boto3_refresh_session-0.0.18.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
-boto3_refresh_session-0.0.18.dist-info/RECORD,,