boto3-refresh-session 0.0.8__tar.gz → 0.0.10__tar.gz

{boto3_refresh_session-0.0.8 → boto3_refresh_session-0.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3-refresh-session
-Version: 0.0.8
+Version: 0.0.10
 Summary: A simple Python package for refreshing boto3 sessions automatically.
 Home-page: https://github.com/michaelthomasletts/boto3-refresh-session
 License: MIT
@@ -32,7 +32,7 @@ Description-Content-Type: text/markdown
 A simple Python package for refreshing boto3 sessions automatically.
 
 ## Features
-- `boto3_refresh_session.AutoRefreshableSession` method for generating an automatically refreshing `boto.Session` object.
+- `boto3_refresh_session.AutoRefreshableSession` method for generating an automatically refreshing `boto3.Session` object.
 
 ## Installation
 
@@ -42,7 +42,9 @@ To install the package using `pip`:
 $ 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.
+**This package assumes that you have `~/.aws/config` or `~/.aws/credentials` files or `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables configured on your machine!** 
+
+Refer to the [boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for additional details about configuring those credentials on your machine.
 
 ## Directory
 
@@ -59,7 +61,10 @@ 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")
+
+session = AutoRefreshableSession(
+    region="us-east-1", role_arn="<your-arn>", session_name="test"
+)
 s3_client = session.session.client(service_name="s3")
 ```
 

{boto3_refresh_session-0.0.8 → boto3_refresh_session-0.0.10}/README.md

@@ -8,7 +8,7 @@
 A simple Python package for refreshing boto3 sessions automatically.
 
 ## Features
-- `boto3_refresh_session.AutoRefreshableSession` method for generating an automatically refreshing `boto.Session` object.
+- `boto3_refresh_session.AutoRefreshableSession` method for generating an automatically refreshing `boto3.Session` object.
 
 ## Installation
 
@@ -18,7 +18,9 @@ To install the package using `pip`:
 $ 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.
+**This package assumes that you have `~/.aws/config` or `~/.aws/credentials` files or `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables configured on your machine!** 
+
+Refer to the [boto3 documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for additional details about configuring those credentials on your machine.
 
 ## Directory
 
@@ -35,7 +37,10 @@ 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")
+
+session = AutoRefreshableSession(
+    region="us-east-1", role_arn="<your-arn>", session_name="test"
+)
 s3_client = session.session.client(service_name="s3")
 ```
 

{boto3_refresh_session-0.0.8 → boto3_refresh_session-0.0.10}/boto3_refresh_session/session.py

@@ -22,7 +22,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 +37,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.

{boto3_refresh_session-0.0.8 → boto3_refresh_session-0.0.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "boto3-refresh-session"
-version = "0.0.8"
+version = "0.0.10"
 description = "A simple Python package for refreshing boto3 sessions automatically."
 authors = [
     {name = "Mike Letts",email = "michaelthomasletts@gmail.com"}