boto3-refresh-session 1.0.36__py3-none-any.whl → 6.2.7__py3-none-any.whl

boto3_refresh_session-1.0.36.dist-info/METADATA

@@ -1,164 +0,0 @@
-Metadata-Version: 2.3
-Name: boto3-refresh-session
-Version: 1.0.36
-Summary: A simple Python package for refreshing the temporary security credentials in a boto3.session.Session object automatically.
-License: MIT
-Keywords: boto3,botocore,aws
-Author: Mike Letts
-Author-email: lettsmt@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: 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
-
-<div align="center">
-  <img src="https://raw.githubusercontent.com/michaelthomasletts/boto3-refresh-session/refs/heads/main/doc/brs.png" />
-</div>
-
-</br>
-
-<div align="center"><em>
-  A simple Python package for refreshing the temporary security credentials in a <code>boto3.session.Session</code> object automatically.
-</em></div>
-
-</br>
-
-<div align="center">
-
-  <a href="https://pypi.org/project/boto3-refresh-session/">
-    <img src="https://img.shields.io/pypi/v/boto3-refresh-session?color=%23FF0000FF&logo=python" alt="PyPI - Version"/>
-  </a>
-
-  <a href="https://github.com/michaelthomasletts/boto3-refresh-session/actions/workflows/push.yml">
-    <img src="https://img.shields.io/github/actions/workflow/status/michaelthomasletts/boto3-refresh-session/push.yml?logo=github&color=%23FF0000FF" alt="Workflow"/>
-  </a>
-
-  <a href="https://pypi.org/project/boto3-refresh-session/">
-    <img src="https://img.shields.io/pypi/pyversions/boto3-refresh-session?style=pypi&color=%23FF0000FF&logo=python" alt="Python Version"/>
-  </a>
-
-  <a href="https://github.com/michaelthomasletts/boto3-refresh-session/commits/main">
-    <img src="https://img.shields.io/github/last-commit/michaelthomasletts/boto3-refresh-session?logo=github&color=%23FF0000FF" alt="GitHub last commit"/>
-  </a>
-
-  <a href="https://pepy.tech/project/boto3-refresh-session">
-    <img src="https://img.shields.io/badge/downloads-45.6K-red?logo=python&color=%23FF0000" alt="Downloads"/>
-  </a>
-
-  <a href="https://michaelthomasletts.github.io/boto3-refresh-session/index.html">
-    <img src="https://img.shields.io/badge/official%20documentation-📘-FF0000?style=flat&labelColor=555&logo=readthedocs" alt="Documentation Badge"/>
-  </a>
-
-  <a href="https://github.com/michaelthomasletts/boto3-refresh-session">
-    <img src="https://img.shields.io/badge/source%20code-💻-FF0000?style=flat&labelColor=555&logo=github" alt="Source Code Badge"/>
-  </a>
-
-  <a href="https://michaelthomasletts.github.io/boto3-refresh-session/qanda.html">
-    <img src="https://img.shields.io/badge/Q%26A-❔-FF0000?style=flat&labelColor=555&logo=vercel" alt="Q&A Badge"/>
-  </a>
-
-</div>
-
-## Features
-
-- Auto-refreshing credentials for long-lived `boto3` sessions
-- Drop-in replacement for `boto3.session.Session`
-- Supports `assume_role` configuration, custom STS clients, and profile / region configuration, as well as all other parameters supported by `boto3.session.Session`
-- Tested, documented, and published to PyPI
-- Used in production at major tech companies
-
-## Adoption
-
-The following line plot illustrates the adoption of BRS in terms of total downloads over a rolling seven day window since the inception of BRS.
-
-<p align="center">
-  <img src="https://raw.githubusercontent.com/michaelthomasletts/boto3-refresh-session/refs/heads/main/doc/downloads.png" />
-</p>
-
-## Testimonials
-
-From a Cyber Security Engineer at a FAANG company:
-
-> _Most of my work is on tooling related to AWS security, so I'm pretty choosy about boto3 credentials-adjacent code. I often opt to just write this sort of thing myself so I at least know that I can reason about it. But I found boto3-refresh-session to be very clean and intuitive . . . we're using the RefreshableSession class as part of a client cache construct . . . we're using AWS Lambda to perform lots of operations across several regions in hundreds of accounts, over and over again, all day every day. And it turns out that there's a surprising amount of overhead to creating boto3 clients (mostly deserializing service definition json), so we can run MUCH more efficiently if we keep a cache of clients, all equipped with automatically refreshing sessions._
-
-## Installation
-
-```bash
-pip install boto3-refresh-session
-```
-
-## Usage
-
-```python
-import boto3_refresh_session as brs
-
-# you can pass all of the params associated with boto3.session.Session
-profile_name = '<your-profile-name>'
-region_name = 'us-east-1'
-...
-
-# as well as all of the params associated with STS.Client.assume_role
-assume_role_kwargs = {
-  'RoleArn': '<your-role-arn>',
-  'RoleSessionName': '<your-role-session-name>',
-  'DurationSeconds': '<your-selection>',
-  ...
-}
-
-# as well as all of the params associated with STS.Client, except for 'service_name'
-sts_client_kwargs = {
-  'region_name': region_name,
-  ...
-}
-
-# basic initialization of boto3.session.Session
-session = brs.RefreshableSession(
-  assume_role_kwargs=assume_role_kwargs, # required
-  sts_client_kwargs=sts_client_kwargs,
-  region_name=region_name,
-  profile_name=profile_name,
-  ...
-)
-
-# now you can create clients, resources, etc. without worrying about expired temporary 
-# security credentials
-s3 = session.client(service_name='s3')
-buckets = s3.list_buckets()
-```
-
-## Raison d'être
-
-It is common for data pipelines and workflows that interact with the AWS API via 
-`boto3` to run for a long time and, accordingly, for temporary credentials to 
-expire. 
-
-Usually, engineers deal with that problem one of two ways: 
-
-- `try except` blocks that catch `ClientError` exceptions
-- A similar approach as that used in this project -- that is, using methods available 
-  within `botocore` for refreshing temporary credentials automatically. 
-  
-Speaking personally, variations of the code found herein exists in code bases at 
-nearly every company where I have worked. Sometimes, I turned that code into a module; 
-other times, I wrote it from scratch. Clearly, that is inefficient.
-
-I decided to finally turn that code into a proper Python package with unit testing, 
-automatic documentation, and quality checks; the idea being that, henceforth, depending 
-on my employer's open source policy, I may simply import this package instead of 
-reproducing the code herein for the Nth time.
-
-If any of that sounds relatable, then `boto3-refresh-session` should help you.
-
----
-
-📄 Licensed under the MIT License.

boto3_refresh_session-1.0.36.dist-info/RECORD

@@ -1,7 +0,0 @@
-boto3_refresh_session/__init__.py,sha256=WGwUI6m0hFjXzTL0PwB9X7KK1rx1l-o9fE0IX40mv5I,158
-boto3_refresh_session/session.py,sha256=jDSjEHIZkGvMEOKzCtcOT7j41rOOoR_tei_dffS0Cww,5887
-boto3_refresh_session-1.0.36.dist-info/LICENSE,sha256=I3ZYTXAjbIly6bm6J-TvFTuuHwTKws4h89QaY5c5HiY,1067
-boto3_refresh_session-1.0.36.dist-info/METADATA,sha256=r6Ns0Voo3H1Hp8LH2GxSP9to_4uOrClhLcoqSE9tqNE,6797
-boto3_refresh_session-1.0.36.dist-info/NOTICE,sha256=1s8r33qbl1z0YvPB942iWgvbkP94P_e8AnROr1qXXuw,939
-boto3_refresh_session-1.0.36.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-boto3_refresh_session-1.0.36.dist-info/RECORD,,