vestara 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.
vestara-0.1.0/LICENSE ADDED
@@ -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 the 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 2026 Ahsan Iqbal
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.
vestara-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,186 @@
1
+ Metadata-Version: 2.4
2
+ Name: vestara
3
+ Version: 0.1.0
4
+ Summary: Python SDK for Vestara crash reporting and remote logging.
5
+ License-Expression: Apache-2.0
6
+ Requires-Python: >=3.8
7
+ Description-Content-Type: text/markdown
8
+ License-File: LICENSE
9
+ Provides-Extra: dev
10
+ Requires-Dist: pytest; extra == "dev"
11
+ Dynamic: license-file
12
+
13
+ # Vestara Python SDK
14
+
15
+ Server-side Python SDK for Vestara crash reporting and remote logging.
16
+
17
+ **Requires Python 3.8+** — zero external runtime dependencies.
18
+
19
+ ## Installation
20
+
21
+ ```bash
22
+ pip install vestara
23
+ ```
24
+
25
+ ## Quick Start
26
+
27
+ ```python
28
+ import vestara
29
+
30
+ vestara.init(
31
+ token="YOUR_SDK_TOKEN",
32
+ environment="production",
33
+ app_version="1.0.0",
34
+ target_category="python_worker",
35
+ service_name="Python Worker",
36
+ app_identifier="python-worker",
37
+ )
38
+
39
+ vestara.log("info", "Server started", {"port": 3000})
40
+ ```
41
+
42
+ Default endpoint: `https://api.vestara.dev`. No `api_url` needed for normal Vestara SaaS usage.
43
+
44
+ ## Runtime target metadata
45
+
46
+ You can provide metadata to identify this application in the dashboard:
47
+ - `target_category`: The kind of target (e.g., `python_worker`).
48
+ - `service_name`: Human-readable name (e.g., `Python Worker`).
49
+ - `app_identifier`: Technical identifier (e.g., `python-worker`).
50
+
51
+ ## API
52
+
53
+ ### `vestara.init(options)`
54
+
55
+ Initializes the SDK. Must be called before any other API.
56
+
57
+ ```python
58
+ vestara.init(
59
+ token="YOUR_SDK_TOKEN",
60
+ environment="production", # production | staging | development
61
+ app_version="1.0.0",
62
+ target_category="python_worker",
63
+ service_name="Python Worker",
64
+ app_identifier="python-worker",
65
+ before_send=None, # optional callback
66
+ )
67
+ ```
68
+
69
+ ### `before_send` hook
70
+
71
+ The `before_send` option lets you inspect, modify, or drop events before they are queued:
72
+
73
+ ```python
74
+ def redact_sensitive(event):
75
+ # Redact sensitive fields
76
+ if "password" in event.get("payload", {}).get("data", {}):
77
+ event = dict(event)
78
+ event["payload"] = dict(event["payload"])
79
+ event["payload"]["data"] = dict(event["payload"]["data"])
80
+ event["payload"]["data"]["password"] = "[REDACTED]"
81
+ return event
82
+
83
+ # Drop noisy health checks
84
+ if event.get("payload", {}).get("message") == "health-check":
85
+ return None
86
+
87
+ return event
88
+
89
+ vestara.init(
90
+ token="YOUR_SDK_TOKEN",
91
+ before_send=redact_sensitive,
92
+ )
93
+ ```
94
+
95
+ Behavior:
96
+ - Return a modified event dict to send the modified version
97
+ - Return `None` to drop the event
98
+ - If the hook raises an exception, the original event is sent (fail-open)
99
+
100
+ Note: The Vestara backend also applies server-side redaction as a safety layer.
101
+
102
+ Optional `api_url` for local development, staging, or self-hosted:
103
+
104
+ ```python
105
+ vestara.init(
106
+ token="YOUR_SDK_TOKEN",
107
+ api_url="http://localhost:3000",
108
+ environment="development",
109
+ )
110
+ ```
111
+
112
+ ### `vestara.log(level, message, data?)`
113
+
114
+ Sends a log event.
115
+
116
+ ```python
117
+ vestara.log("info", "Request processed", {"request_id": "123"})
118
+ vestara.log("warn", "Slow query detected", {"duration": 2000})
119
+ vestara.log("error", "Database connection failed", {"host": "db.example.com"})
120
+ ```
121
+
122
+ Supported levels: `debug`, `info`, `warn`, `error`, `fatal`.
123
+
124
+ ### `vestara.capture_exception(error, context?)`
125
+
126
+ Captures a Python exception.
127
+
128
+ ```python
129
+ try:
130
+ result = process_data()
131
+ except Exception as e:
132
+ vestara.capture_exception(e, {"operation": "process_data"})
133
+ ```
134
+
135
+ ### `vestara.set_user(context)`
136
+
137
+ Associates a user with future events.
138
+
139
+ ```python
140
+ vestara.set_user({"id": "user-123", "email": "user@example.com"})
141
+ ```
142
+
143
+ ## What is Automatically Captured
144
+
145
+ - **Uncaught exceptions**: `sys.excepthook` captures unhandled exceptions. The original hook is called after capture.
146
+ - **Thread exceptions**: `threading.excepthook` captures uncaught exceptions in threads. The original hook is called after capture.
147
+ - **Graceful shutdown**: Remaining events are flushed on process exit via `atexit`.
148
+ - **Periodic flush**: Events are sent every 10 seconds in a background daemon thread.
149
+
150
+ ## What is NOT Supported in V1
151
+
152
+ - **Async/await exceptions**: Only synchronous thread exceptions are captured automatically.
153
+ - **Django/FastAPI/Flask integration**: Not built-in. Wrap your exception handlers or call `vestara.capture_exception()` manually.
154
+ - **Structured logging frameworks**: Not auto-instrumented.
155
+ - **Distributed tracing / APM**: Not implemented.
156
+ - **Guaranteed persistence**: Queue is in-memory only. SIGKILL or sudden process termination will lose queued events.
157
+ - **File-backed queue**: Not implemented.
158
+
159
+ ## Offline Queue
160
+
161
+ Events are queued in memory (not persisted to disk).
162
+
163
+ - Max 500 events
164
+ - Logs dropped (not crashes) when queue is full
165
+ - Crash events evict the oldest log when queue is full
166
+ - Events are sent in batches of up to 50 every 10 seconds
167
+ - Crash events are sent immediately
168
+ - Remaining events are flushed on `atexit` (best-effort, may not complete on SIGKILL)
169
+
170
+ ## Device Settings
171
+
172
+ The SDK polls `/v1/sdk/device-settings` every 60 seconds. If `logging_enabled` is `false`, log events are suppressed. Crash events are always sent regardless of this setting.
173
+
174
+ ## SDK Token
175
+
176
+ Find your SDK token in the Vestara dashboard under **Settings → SDK & Token**.
177
+
178
+ > The SDK token is write-only — it can only ingest events. It cannot read your data.
179
+
180
+ ## License
181
+
182
+ This SDK is licensed under the Apache License 2.0.
183
+
184
+ Copyright 2026 Ahsan Iqbal.
185
+
186
+ Vestara, the Vestara name, logos, domain, and related branding are not granted under this license.
@@ -0,0 +1,174 @@
1
+ # Vestara Python SDK
2
+
3
+ Server-side Python SDK for Vestara crash reporting and remote logging.
4
+
5
+ **Requires Python 3.8+** — zero external runtime dependencies.
6
+
7
+ ## Installation
8
+
9
+ ```bash
10
+ pip install vestara
11
+ ```
12
+
13
+ ## Quick Start
14
+
15
+ ```python
16
+ import vestara
17
+
18
+ vestara.init(
19
+ token="YOUR_SDK_TOKEN",
20
+ environment="production",
21
+ app_version="1.0.0",
22
+ target_category="python_worker",
23
+ service_name="Python Worker",
24
+ app_identifier="python-worker",
25
+ )
26
+
27
+ vestara.log("info", "Server started", {"port": 3000})
28
+ ```
29
+
30
+ Default endpoint: `https://api.vestara.dev`. No `api_url` needed for normal Vestara SaaS usage.
31
+
32
+ ## Runtime target metadata
33
+
34
+ You can provide metadata to identify this application in the dashboard:
35
+ - `target_category`: The kind of target (e.g., `python_worker`).
36
+ - `service_name`: Human-readable name (e.g., `Python Worker`).
37
+ - `app_identifier`: Technical identifier (e.g., `python-worker`).
38
+
39
+ ## API
40
+
41
+ ### `vestara.init(options)`
42
+
43
+ Initializes the SDK. Must be called before any other API.
44
+
45
+ ```python
46
+ vestara.init(
47
+ token="YOUR_SDK_TOKEN",
48
+ environment="production", # production | staging | development
49
+ app_version="1.0.0",
50
+ target_category="python_worker",
51
+ service_name="Python Worker",
52
+ app_identifier="python-worker",
53
+ before_send=None, # optional callback
54
+ )
55
+ ```
56
+
57
+ ### `before_send` hook
58
+
59
+ The `before_send` option lets you inspect, modify, or drop events before they are queued:
60
+
61
+ ```python
62
+ def redact_sensitive(event):
63
+ # Redact sensitive fields
64
+ if "password" in event.get("payload", {}).get("data", {}):
65
+ event = dict(event)
66
+ event["payload"] = dict(event["payload"])
67
+ event["payload"]["data"] = dict(event["payload"]["data"])
68
+ event["payload"]["data"]["password"] = "[REDACTED]"
69
+ return event
70
+
71
+ # Drop noisy health checks
72
+ if event.get("payload", {}).get("message") == "health-check":
73
+ return None
74
+
75
+ return event
76
+
77
+ vestara.init(
78
+ token="YOUR_SDK_TOKEN",
79
+ before_send=redact_sensitive,
80
+ )
81
+ ```
82
+
83
+ Behavior:
84
+ - Return a modified event dict to send the modified version
85
+ - Return `None` to drop the event
86
+ - If the hook raises an exception, the original event is sent (fail-open)
87
+
88
+ Note: The Vestara backend also applies server-side redaction as a safety layer.
89
+
90
+ Optional `api_url` for local development, staging, or self-hosted:
91
+
92
+ ```python
93
+ vestara.init(
94
+ token="YOUR_SDK_TOKEN",
95
+ api_url="http://localhost:3000",
96
+ environment="development",
97
+ )
98
+ ```
99
+
100
+ ### `vestara.log(level, message, data?)`
101
+
102
+ Sends a log event.
103
+
104
+ ```python
105
+ vestara.log("info", "Request processed", {"request_id": "123"})
106
+ vestara.log("warn", "Slow query detected", {"duration": 2000})
107
+ vestara.log("error", "Database connection failed", {"host": "db.example.com"})
108
+ ```
109
+
110
+ Supported levels: `debug`, `info`, `warn`, `error`, `fatal`.
111
+
112
+ ### `vestara.capture_exception(error, context?)`
113
+
114
+ Captures a Python exception.
115
+
116
+ ```python
117
+ try:
118
+ result = process_data()
119
+ except Exception as e:
120
+ vestara.capture_exception(e, {"operation": "process_data"})
121
+ ```
122
+
123
+ ### `vestara.set_user(context)`
124
+
125
+ Associates a user with future events.
126
+
127
+ ```python
128
+ vestara.set_user({"id": "user-123", "email": "user@example.com"})
129
+ ```
130
+
131
+ ## What is Automatically Captured
132
+
133
+ - **Uncaught exceptions**: `sys.excepthook` captures unhandled exceptions. The original hook is called after capture.
134
+ - **Thread exceptions**: `threading.excepthook` captures uncaught exceptions in threads. The original hook is called after capture.
135
+ - **Graceful shutdown**: Remaining events are flushed on process exit via `atexit`.
136
+ - **Periodic flush**: Events are sent every 10 seconds in a background daemon thread.
137
+
138
+ ## What is NOT Supported in V1
139
+
140
+ - **Async/await exceptions**: Only synchronous thread exceptions are captured automatically.
141
+ - **Django/FastAPI/Flask integration**: Not built-in. Wrap your exception handlers or call `vestara.capture_exception()` manually.
142
+ - **Structured logging frameworks**: Not auto-instrumented.
143
+ - **Distributed tracing / APM**: Not implemented.
144
+ - **Guaranteed persistence**: Queue is in-memory only. SIGKILL or sudden process termination will lose queued events.
145
+ - **File-backed queue**: Not implemented.
146
+
147
+ ## Offline Queue
148
+
149
+ Events are queued in memory (not persisted to disk).
150
+
151
+ - Max 500 events
152
+ - Logs dropped (not crashes) when queue is full
153
+ - Crash events evict the oldest log when queue is full
154
+ - Events are sent in batches of up to 50 every 10 seconds
155
+ - Crash events are sent immediately
156
+ - Remaining events are flushed on `atexit` (best-effort, may not complete on SIGKILL)
157
+
158
+ ## Device Settings
159
+
160
+ The SDK polls `/v1/sdk/device-settings` every 60 seconds. If `logging_enabled` is `false`, log events are suppressed. Crash events are always sent regardless of this setting.
161
+
162
+ ## SDK Token
163
+
164
+ Find your SDK token in the Vestara dashboard under **Settings → SDK & Token**.
165
+
166
+ > The SDK token is write-only — it can only ingest events. It cannot read your data.
167
+
168
+ ## License
169
+
170
+ This SDK is licensed under the Apache License 2.0.
171
+
172
+ Copyright 2026 Ahsan Iqbal.
173
+
174
+ Vestara, the Vestara name, logos, domain, and related branding are not granted under this license.
@@ -0,0 +1,17 @@
1
+ [project]
2
+ name = "vestara"
3
+ version = "0.1.0"
4
+ description = "Python SDK for Vestara crash reporting and remote logging."
5
+ requires-python = ">=3.8"
6
+ readme = "README.md"
7
+ license = "Apache-2.0"
8
+
9
+ [project.optional-dependencies]
10
+ dev = ["pytest"]
11
+
12
+ [build-system]
13
+ requires = ["setuptools>=61.0"]
14
+ build-backend = "setuptools.build_meta"
15
+
16
+ [tool.pytest.ini_options]
17
+ pythonpath = ["."]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+