boto3-refresh-session 0.0.9__py3-none-any.whl → 0.0.11__py3-none-any.whl

boto3_refresh_session/session.py

@@ -1,3 +1,15 @@
+"""
+Helper method for generating an automatically refreshing `boto3.Session`
+object.
+
+.. currentmodule:: boto3_refresh_session.session
+
+.. autosummary::
+    :toctree: session/
+
+    AutoRefreshableSession
+"""
+
 from __future__ import annotations
 
 __all__ = ["AutoRefreshableSession"]
@@ -22,7 +34,7 @@ class AutoRefreshableSession:
     To use this class, you must have `~/.aws/config` or `~/.aws/credentials`
     on your machine.
 
-    Attributes
+    Parameters
     ----------
     region : str
         AWS region name.
@@ -37,8 +49,8 @@ class AutoRefreshableSession:
     client_kwargs : dict, optional
         Optional keyword arguments for `boto3.Session.client`.
 
-    Other Attributes
-    ----------------
+    Attributes
+    ----------
     session
         Returns a boto3 Session object with credentials which refresh
         automatically.
@@ -55,7 +67,6 @@ class AutoRefreshableSession:
     --------
     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>",

{boto3_refresh_session-0.0.9.dist-info → boto3_refresh_session-0.0.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3-refresh-session
-Version: 0.0.9
+Version: 0.0.11
 Summary: A simple Python package for refreshing boto3 sessions automatically.
 Home-page: https://github.com/michaelthomasletts/boto3-refresh-session
 License: MIT
@@ -19,6 +19,7 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: attrs (>=24.3.0,<25.0.0)
 Requires-Dist: boto3
 Requires-Dist: botocore
+Project-URL: Documentation, https://michaelthomasletts.github.io/boto3-refresh-session/index.html
 Project-URL: Repository, https://github.com/michaelthomasletts/boto3-refresh-session
 Description-Content-Type: text/markdown
 
@@ -31,6 +32,10 @@ Description-Content-Type: text/markdown
 
 A simple Python package for refreshing boto3 sessions automatically.
 
+## Links
+
+[Official Documentation](https://michaelthomasletts.github.io/boto3-refresh-session/index.html)
+
 ## Features
 - `boto3_refresh_session.AutoRefreshableSession` method for generating an automatically refreshing `boto3.Session` object.
 
@@ -67,7 +72,3 @@ session = AutoRefreshableSession(
 )
 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 step by step instructions.

boto3_refresh_session-0.0.11.dist-info/RECORD

@@ -0,0 +1,6 @@
+boto3_refresh_session/__init__.py,sha256=OMY8el4qROyEvo0vr1Kv8rtFU7g3xnjHuBss54XRTEA,135
+boto3_refresh_session/session.py,sha256=4AxunP-eQtjyT2NbTnC8elgMDcPlMY55LDrSE1XPKgY,3972
+boto3_refresh_session-0.0.11.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
+boto3_refresh_session-0.0.11.dist-info/METADATA,sha256=wj79tsjK3BcthjKOdlEzNxpF4p0gNoEY_-ZUlp6OCaI,2705
+boto3_refresh_session-0.0.11.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
+boto3_refresh_session-0.0.11.dist-info/RECORD,,

boto3_refresh_session-0.0.9.dist-info/RECORD

@@ -1,6 +0,0 @@
-boto3_refresh_session/__init__.py,sha256=OMY8el4qROyEvo0vr1Kv8rtFU7g3xnjHuBss54XRTEA,135
-boto3_refresh_session/session.py,sha256=D-qiFGdy52zzkVnI94Z5hjk3kmb-UkR2fCM77caC3sg,3840
-boto3_refresh_session-0.0.9.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
-boto3_refresh_session-0.0.9.dist-info/METADATA,sha256=o5AsobuyEq5yhb7G_d9jEjViktyporBq5-Zq4ny-WnY,2665
-boto3_refresh_session-0.0.9.dist-info/WHEEL,sha256=RaoafKOydTQ7I_I3JTrPCg6kUmTgtm4BornzOqyEfJ8,88
-boto3_refresh_session-0.0.9.dist-info/RECORD,,