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

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: boto3-refresh-session
3
- Version: 0.0.10
3
+ Version: 0.0.11
4
4
  Summary: A simple Python package for refreshing boto3 sessions automatically.
5
5
  Home-page: https://github.com/michaelthomasletts/boto3-refresh-session
6
6
  License: MIT
@@ -19,6 +19,7 @@ Classifier: Programming Language :: Python :: 3.13
19
19
  Requires-Dist: attrs (>=24.3.0,<25.0.0)
20
20
  Requires-Dist: boto3
21
21
  Requires-Dist: botocore
22
+ Project-URL: Documentation, https://michaelthomasletts.github.io/boto3-refresh-session/index.html
22
23
  Project-URL: Repository, https://github.com/michaelthomasletts/boto3-refresh-session
23
24
  Description-Content-Type: text/markdown
24
25
 
@@ -31,6 +32,10 @@ Description-Content-Type: text/markdown
31
32
 
32
33
  A simple Python package for refreshing boto3 sessions automatically.
33
34
 
35
+ ## Links
36
+
37
+ [Official Documentation](https://michaelthomasletts.github.io/boto3-refresh-session/index.html)
38
+
34
39
  ## Features
35
40
  - `boto3_refresh_session.AutoRefreshableSession` method for generating an automatically refreshing `boto3.Session` object.
36
41
 
@@ -67,7 +72,3 @@ session = AutoRefreshableSession(
67
72
  )
68
73
  s3_client = session.session.client(service_name="s3")
69
74
  ```
70
-
71
- ## Contributing
72
-
73
- Refer to [this document](https://github.com/michaelthomasletts/boto3-refresh-session/blob/main/docs/contributing.md) for step by step instructions.
@@ -7,6 +7,10 @@
7
7
 
8
8
  A simple Python package for refreshing boto3 sessions automatically.
9
9
 
10
+ ## Links
11
+
12
+ [Official Documentation](https://michaelthomasletts.github.io/boto3-refresh-session/index.html)
13
+
10
14
  ## Features
11
15
  - `boto3_refresh_session.AutoRefreshableSession` method for generating an automatically refreshing `boto3.Session` object.
12
16
 
@@ -42,8 +46,4 @@ session = AutoRefreshableSession(
42
46
  region="us-east-1", role_arn="<your-arn>", session_name="test"
43
47
  )
44
48
  s3_client = session.session.client(service_name="s3")
45
- ```
46
-
47
- ## Contributing
48
-
49
- Refer to [this document](https://github.com/michaelthomasletts/boto3-refresh-session/blob/main/docs/contributing.md) for step by step instructions.
49
+ ```
@@ -1,3 +1,15 @@
1
+ """
2
+ Helper method for generating an automatically refreshing `boto3.Session`
3
+ object.
4
+
5
+ .. currentmodule:: boto3_refresh_session.session
6
+
7
+ .. autosummary::
8
+ :toctree: session/
9
+
10
+ AutoRefreshableSession
11
+ """
12
+
1
13
  from __future__ import annotations
2
14
 
3
15
  __all__ = ["AutoRefreshableSession"]
@@ -55,7 +67,6 @@ class AutoRefreshableSession:
55
67
  --------
56
68
  Here's how to initialize the `boto3.Client.S3` object:
57
69
 
58
- >>> from boto3_refresh_session import AutoRefreshableSession
59
70
  >>> session = AutoRefreshableSession(
60
71
  >>> region="us-east-1",
61
72
  >>> role_arn="<your-arn>",
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "boto3-refresh-session"
3
- version = "0.0.10"
3
+ version = "0.0.11"
4
4
  description = "A simple Python package for refreshing boto3 sessions automatically."
5
5
  authors = [
6
6
  {name = "Mike Letts",email = "michaelthomasletts@gmail.com"}
@@ -16,6 +16,7 @@ maintainers = [
16
16
 
17
17
  [project.urls]
18
18
  repository = "https://github.com/michaelthomasletts/boto3-refresh-session"
19
+ documentation = "https://michaelthomasletts.github.io/boto3-refresh-session/index.html"
19
20
 
20
21
  [build-system]
21
22
  requires = ["poetry-core>=2.0.0,<3.0.0"]
@@ -27,6 +28,9 @@ black = "^24.10.0"
27
28
  isort = "^5.13.2"
28
29
  flake8 = "^7.1.1"
29
30
  pre-commit = "^4.0.1"
31
+ sphinx = "^8.1.3"
32
+ pydata-sphinx-theme = "^0.16.1"
33
+ numpydoc = "^1.8.0"
30
34
 
31
35
  [tool.black]
32
36
  line-length = 79