Skip to content

Commit b0d49d4

Browse files
adjusted warning message
1 parent f5eb5e9 commit b0d49d4

File tree

3 files changed

+11
-19
lines changed

3 files changed

+11
-19
lines changed

boto3_refresh_session/session.py

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,11 @@
66
77
.. warning::
88
``AutoRefreshableSession`` was not tested for manually passing hard-coded
9-
account credentials to the :class:`boto3.session.Session` or ``boto3.client``
10-
objects! There are optional ``session_kwargs`` and ``client_kwargs``
11-
parameters available for passing hard-coded account credentials, which
12-
should work; however, that cannot be guaranteed! In any case, the ``boto3``
13-
documentation generally recommends against passing hard-coded account credentials
14-
as parameters; it is for that reason the documentation below, and everywhere
15-
else, only mentions ``~/.aws/config`` and ``~/.aws/credentials`` for
16-
authorization. Since the ``session_kwargs`` and ``client_kwargs`` parameters
17-
were not tested, you will need to use those parameters at your own discretion.
9+
account credentials to the ``boto3.client`` object! There is an optional
10+
``client_kwargs`` parameter available for doing so, which *should* work;
11+
however, that cannot be guaranteed as that functionality was not tested.
12+
Pass hard-coded credentials with the ``client_kwargs`` parameter at your
13+
own discretion.
1814
"""
1915
__all__ = ["AutoRefreshableSession"]
2016

doc/authorization.rst

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,11 @@ Authorization
55

66
.. warning::
77
``AutoRefreshableSession`` was not tested for manually passing hard-coded
8-
account credentials to the :class:`boto3.session.Session` or ``boto3.client``
9-
objects! There are optional ``session_kwargs`` and ``client_kwargs``
10-
parameters available for passing hard-coded account credentials, which
11-
*should* work; however, that cannot be guaranteed! In any case, the ``boto3``
12-
documentation generally recommends against passing hard-coded account credentials
13-
as parameters; it is for that reason the documentation below, and everywhere
14-
else, only mentions ``~/.aws/config`` and ``~/.aws/credentials`` for
15-
authorization. Since the ``session_kwargs`` and ``client_kwargs`` parameters
16-
were not tested, you will need to use those parameters at your own discretion.
8+
account credentials to the ``boto3.client`` object! There is an optional
9+
``client_kwargs`` parameter available for doing so, which *should* work;
10+
however, that cannot be guaranteed as that functionality was not tested.
11+
Pass hard-coded credentials with the ``client_kwargs`` parameter at your
12+
own discretion.
1713

1814
In order to use this package, it is **recommended** that you follow one of the
1915
below methods for authorizing access to your AWS instance:

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "boto3-refresh-session"
3-
version = "0.0.26"
3+
version = "0.0.27"
44
description = "A simple Python package for refreshing boto3 sessions automatically."
55
authors = [
66
{name = "Mike Letts",email = "michaelthomasletts@gmail.com"}

0 commit comments

Comments
 (0)