Metadata-Version: 2.3
Name: boto3-refresh-session
Version: 0.0.2
Summary: A simple Python package for refreshing boto3 sessions automatically.
Home-page: https://github.com/michaelthomasletts/gspread-helpers
License: MIT
Keywords: boto3,botocore,aws
Author: Mike Letts
Author-email: michaelthomasletts@gmail.com
Maintainer: Michael Letts
Maintainer-email: lettsmt@gmail.com
Requires-Python: >=3.10
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: attrs (>=24.3.0,<25.0.0)
Requires-Dist: boto3
Requires-Dist: botocore
Project-URL: Repository, https://github.com/michaelthomasletts/gspread-helpers
Description-Content-Type: text/markdown

# 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 `boto.Session` object.

## Installation

To install the package using `pip`:

```bash
$ 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.

## 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")
```
