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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: boto3-refresh-session
-Version: 0.0.10
+Version: 0.0.12
 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,43 +32,6 @@ 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 `boto3.Session` object.
+## Usage and Installation
 
-## Installation
-
-To install the package using `pip`:
-
-```bash
-$ pip install boto3-refresh-session
-```
-
-**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
-
-```
-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 step by step instructions.
+[Official Documentation](https://michaelthomasletts.github.io/boto3-refresh-session/index.html)

boto3_refresh_session-0.0.12/README.md

@@ -0,0 +1,12 @@
+# 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.
+
+## Usage and Installation
+
+[Official Documentation](https://michaelthomasletts.github.io/boto3-refresh-session/index.html)

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

@@ -1,5 +1,9 @@
 from __future__ import annotations
 
+__doc__ = """
+Helper method for generating an automatically refreshing ``boto3.Session``
+object.
+"""
 __all__ = ["AutoRefreshableSession"]
 
 from typing import Type
@@ -13,14 +17,14 @@ from botocore.session import get_session
 
 @define
 class AutoRefreshableSession:
-    """Returns a boto3 Session object which refreshes automatically, no extra
+    """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.
+    To use this class, you must have ``~/.aws/config`` or ``~/.aws/credentials``
+    configured on your machine.
 
     Parameters
     ----------
@@ -33,14 +37,14 @@ 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 ``boto3.Session``.
     client_kwargs : dict, optional
-        Optional keyword arguments for `boto3.Session.client`.
+        Optional keyword arguments for ``boto3.Session.client``.
 
     Attributes
     ----------
     session
-        Returns a boto3 Session object with credentials which refresh
+        Returns a ``boto3.Session`` object with credentials which refresh
         automatically.
 
     Notes
@@ -49,14 +53,13 @@ class AutoRefreshableSession:
 
     https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html
 
-    This class assumes that `~/.aws` exists with `/config` or `/credentials`!
+    This class assumes that ``~/.aws`` exists with ``/config`` or ``/credentials``!
 
     Examples
     --------
-    Here's how to initialize the `boto3.Client.S3` object:
+    Here's how to initialize the ``boto3.Client.S3`` object:
 
-    >>> from boto3_refresh_session import AutoRefreshableSession
-    >>> session = AutoRefreshableSession(
+    >>> sess = AutoRefreshableSession(
     >>>   region="us-east-1",
     >>>   role_arn="<your-arn>",
     >>>   session_name="test",

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

@@ -1,6 +1,6 @@
 [project]
 name = "boto3-refresh-session"
-version = "0.0.10"
+version = "0.0.12"
 description = "A simple Python package for refreshing boto3 sessions automatically."
 authors = [
     {name = "Mike Letts",email = "michaelthomasletts@gmail.com"}
@@ -16,6 +16,7 @@ maintainers = [
 
 [project.urls]
 repository = "https://github.com/michaelthomasletts/boto3-refresh-session"
+documentation = "https://michaelthomasletts.github.io/boto3-refresh-session/index.html"
 
 [build-system]
 requires = ["poetry-core>=2.0.0,<3.0.0"]
@@ -27,6 +28,9 @@ black = "^24.10.0"
 isort = "^5.13.2"
 flake8 = "^7.1.1"
 pre-commit = "^4.0.1"
+sphinx = "^8.1.3"
+pydata-sphinx-theme = "^0.16.1"
+numpydoc = "^1.8.0"
 
 [tool.black]
 line-length = 79

boto3_refresh_session-0.0.10/README.md

@@ -1,49 +0,0 @@
-# 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 `boto3.Session` object.
-
-## Installation
-
-To install the package using `pip`:
-
-```bash
-$ pip install boto3-refresh-session
-```
-
-**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
-
-```
-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 step by step instructions.