steadwing 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,8 @@
1
+ {
2
+ "permissions": {
3
+ "allow": [
4
+ "Bash(pip index *)",
5
+ "Bash(pip install *)"
6
+ ]
7
+ }
8
+ }
@@ -0,0 +1,69 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # Unit test / coverage reports
30
+ htmlcov/
31
+ .tox/
32
+ .nox/
33
+ .coverage
34
+ .coverage.*
35
+ .cache
36
+ nosetests.xml
37
+ coverage.xml
38
+ *.cover
39
+ *.py,cover
40
+ .hypothesis/
41
+ .pytest_cache/
42
+ cover/
43
+
44
+ # Type checkers / linters
45
+ .mypy_cache/
46
+ .dmypy.json
47
+ dmypy.json
48
+ .pyre/
49
+ .pytype/
50
+ .ruff_cache/
51
+
52
+ # Environments
53
+ .env
54
+ .venv
55
+ env/
56
+ venv/
57
+ ENV/
58
+ env.bak/
59
+ venv.bak/
60
+
61
+ # IDEs / editors
62
+ .idea/
63
+ .vscode/
64
+ *.swp
65
+ *.swo
66
+
67
+ # OS
68
+ .DS_Store
69
+ Thumbs.db
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,114 @@
1
+ Metadata-Version: 2.4
2
+ Name: steadwing
3
+ Version: 0.1.0
4
+ Summary: Steadwing Python SDK — auto-captures exceptions, error logs and HTTP breadcrumbs
5
+ License-Expression: Apache-2.0
6
+ License-File: LICENSE
7
+ Requires-Python: >=3.10
8
+ Requires-Dist: httpx>=0.28.1
9
+ Description-Content-Type: text/markdown
10
+
11
+ # Steadwing Python SDK
12
+
13
+ Auto-captures exceptions, error logs, and HTTP breadcrumbs from Python applications and sends them to the Steadwing backend for Root Cause Analysis.
14
+
15
+ ## Installation
16
+
17
+ ```bash
18
+ pip install steadwing
19
+ ```
20
+
21
+ ## Quick Start
22
+
23
+ ```python
24
+ import steadwing
25
+
26
+ steadwing.init(
27
+ api_key="st_your_api_key",
28
+ service="payment-service",
29
+ environment="production",
30
+ )
31
+ ```
32
+
33
+ That's it. The SDK will automatically:
34
+ - Capture unhandled exceptions (including in threads)
35
+ - Capture `logging.error()` and `logging.critical()` calls
36
+ - Record outgoing HTTP requests as breadcrumbs
37
+ - Send heartbeats every 60 seconds
38
+ - Patch FastAPI to capture route errors with request context (if installed)
39
+
40
+ ## Configuration
41
+
42
+ ```python
43
+ steadwing.init(
44
+ api_key="st_...", # Required: your API key
45
+ service="my-service", # Required: service name
46
+ environment="production", # Optional: defaults to "production"
47
+ enabled=True, # Optional: set False to disable
48
+ backend_url="https://...", # Optional: override backend URL
49
+ )
50
+ ```
51
+
52
+ The backend URL can also be set via the `STEADWING_BACKEND_URL` environment variable.
53
+
54
+ ## Manual Capture
55
+
56
+ ```python
57
+ import steadwing
58
+
59
+ # Capture a specific exception
60
+ try:
61
+ risky_operation()
62
+ except Exception as e:
63
+ steadwing.capture_exception(e)
64
+
65
+ # Capture the current exception (in an except block)
66
+ try:
67
+ risky_operation()
68
+ except Exception:
69
+ steadwing.capture_exception()
70
+
71
+ # Capture a message
72
+ steadwing.capture_message("Deployment completed", level="info")
73
+ ```
74
+
75
+ ## What Gets Captured
76
+
77
+ ### Exceptions
78
+ - Full stack trace with local variables
79
+ - Exception chain (`__cause__`, `__context__`)
80
+ - Last 100 breadcrumbs leading up to the error
81
+ - Request context (for FastAPI routes)
82
+
83
+ ### Logs
84
+ - `logging.error()` and `logging.critical()` are sent as events
85
+ - All log levels are recorded as breadcrumbs
86
+
87
+ ### Breadcrumbs
88
+ - Outgoing HTTP requests (method, URL, duration)
89
+ - Log messages at any level
90
+ - Rolling buffer of last 100 entries
91
+
92
+ ## Data Scrubbing
93
+
94
+ Sensitive data is automatically scrubbed from captured events. Keys matching the following patterns (case-insensitive) have their values replaced with `[REDACTED]`:
95
+
96
+ `password`, `passwd`, `secret`, `api_key`, `apikey`, `token`, `auth`, `authorization`, `cookie`, `csrf`, `session`, `credit_card`, `ssn`
97
+
98
+ ## Development
99
+
100
+ ```bash
101
+ # Install dev dependencies
102
+ pip install -e ".[dev]"
103
+
104
+ # Run tests
105
+ pytest
106
+
107
+ # Run specific tests
108
+ pytest tests/test_scrubber.py -v
109
+ ```
110
+
111
+ ## Requirements
112
+
113
+ - Python >= 3.10
114
+ - httpx >= 0.24.0
@@ -0,0 +1,104 @@
1
+ # Steadwing Python SDK
2
+
3
+ Auto-captures exceptions, error logs, and HTTP breadcrumbs from Python applications and sends them to the Steadwing backend for Root Cause Analysis.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ pip install steadwing
9
+ ```
10
+
11
+ ## Quick Start
12
+
13
+ ```python
14
+ import steadwing
15
+
16
+ steadwing.init(
17
+ api_key="st_your_api_key",
18
+ service="payment-service",
19
+ environment="production",
20
+ )
21
+ ```
22
+
23
+ That's it. The SDK will automatically:
24
+ - Capture unhandled exceptions (including in threads)
25
+ - Capture `logging.error()` and `logging.critical()` calls
26
+ - Record outgoing HTTP requests as breadcrumbs
27
+ - Send heartbeats every 60 seconds
28
+ - Patch FastAPI to capture route errors with request context (if installed)
29
+
30
+ ## Configuration
31
+
32
+ ```python
33
+ steadwing.init(
34
+ api_key="st_...", # Required: your API key
35
+ service="my-service", # Required: service name
36
+ environment="production", # Optional: defaults to "production"
37
+ enabled=True, # Optional: set False to disable
38
+ backend_url="https://...", # Optional: override backend URL
39
+ )
40
+ ```
41
+
42
+ The backend URL can also be set via the `STEADWING_BACKEND_URL` environment variable.
43
+
44
+ ## Manual Capture
45
+
46
+ ```python
47
+ import steadwing
48
+
49
+ # Capture a specific exception
50
+ try:
51
+ risky_operation()
52
+ except Exception as e:
53
+ steadwing.capture_exception(e)
54
+
55
+ # Capture the current exception (in an except block)
56
+ try:
57
+ risky_operation()
58
+ except Exception:
59
+ steadwing.capture_exception()
60
+
61
+ # Capture a message
62
+ steadwing.capture_message("Deployment completed", level="info")
63
+ ```
64
+
65
+ ## What Gets Captured
66
+
67
+ ### Exceptions
68
+ - Full stack trace with local variables
69
+ - Exception chain (`__cause__`, `__context__`)
70
+ - Last 100 breadcrumbs leading up to the error
71
+ - Request context (for FastAPI routes)
72
+
73
+ ### Logs
74
+ - `logging.error()` and `logging.critical()` are sent as events
75
+ - All log levels are recorded as breadcrumbs
76
+
77
+ ### Breadcrumbs
78
+ - Outgoing HTTP requests (method, URL, duration)
79
+ - Log messages at any level
80
+ - Rolling buffer of last 100 entries
81
+
82
+ ## Data Scrubbing
83
+
84
+ Sensitive data is automatically scrubbed from captured events. Keys matching the following patterns (case-insensitive) have their values replaced with `[REDACTED]`:
85
+
86
+ `password`, `passwd`, `secret`, `api_key`, `apikey`, `token`, `auth`, `authorization`, `cookie`, `csrf`, `session`, `credit_card`, `ssn`
87
+
88
+ ## Development
89
+
90
+ ```bash
91
+ # Install dev dependencies
92
+ pip install -e ".[dev]"
93
+
94
+ # Run tests
95
+ pytest
96
+
97
+ # Run specific tests
98
+ pytest tests/test_scrubber.py -v
99
+ ```
100
+
101
+ ## Requirements
102
+
103
+ - Python >= 3.10
104
+ - httpx >= 0.24.0
@@ -0,0 +1,17 @@
1
+ [build-system]
2
+ requires = ["hatchling"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ name = "steadwing"
7
+ version = "0.1.0"
8
+ description = "Steadwing Python SDK — auto-captures exceptions, error logs and HTTP breadcrumbs"
9
+ readme = "README.md"
10
+ license = "Apache-2.0"
11
+ requires-python = ">=3.10"
12
+ dependencies = [
13
+ "httpx>=0.28.1",
14
+ ]
15
+
16
+ [tool.hatch.build.targets.wheel]
17
+ packages = ["steadwing"]
@@ -0,0 +1,42 @@
1
+ """Steadwing Python SDK — auto-captures exceptions, error logs, and HTTP breadcrumbs."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from steadwing.client import SteadwingClient
6
+ from steadwing.types import SDK_VERSION
7
+
8
+ __version__ = SDK_VERSION
9
+
10
+
11
+ def init(
12
+ api_key: str,
13
+ service: str,
14
+ env: str = "PROD",
15
+ enabled: bool = True,
16
+ ) -> SteadwingClient:
17
+ """Initialize the Steadwing SDK.
18
+
19
+ Idempotent — returns existing client if already initialized.
20
+ Pure auto-capture: no manual API needed after init.
21
+
22
+ Args:
23
+ api_key: Your Steadwing API key (e.g. "st_...").
24
+ service: Name of your service (e.g. "payment-service").
25
+ env: Deployment environment (e.g. "PROD", "DEV").
26
+ enabled: Whether to enable capture (default True). Set False to disable.
27
+
28
+ Returns:
29
+ The initialized SteadwingClient instance.
30
+ """
31
+ existing = SteadwingClient.get_instance()
32
+ if existing is not None:
33
+ return existing
34
+
35
+ client = SteadwingClient(
36
+ api_key=api_key,
37
+ service=service,
38
+ env=env,
39
+ enabled=enabled,
40
+ )
41
+ SteadwingClient.set_instance(client)
42
+ return client