watchup 1.0.0__tar.gz

watchup-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Watchup Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

watchup-1.0.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE
+recursive-include watchup *.py

watchup-1.0.0/PKG-INFO

@@ -0,0 +1,224 @@
+Metadata-Version: 2.4
+Name: watchup
+Version: 1.0.0
+Summary: Watchup SDK for Python - Error and event tracking
+Home-page: https://github.com/watchupltd/watchup-python
+Author: Watchup Ltd
+Author-email: support@watchup.com
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-python
+Dynamic: summary
+
+# Watchup Python SDK
+
+Official Python SDK for Watchup incident tracking.
+
+## Installation
+
+```bash
+pip install watchup
+```
+
+## Quick Start
+
+```python
+import watchup
+
+# Initialize the client
+watchup.init(
+    api_key="your-api-key",
+    project_id="your-project-id",
+    environment="production"
+)
+
+# Capture an error
+try:
+    risky_operation()
+except Exception as e:
+    watchup.capture_error(e)
+
+# Capture a message
+watchup.capture_message("User completed checkout", level="info")
+
+# Set user context
+watchup.set_user({
+    "id": "user-123",
+    "email": "user@example.com",
+    "username": "john_doe"
+})
+
+# Add breadcrumbs
+watchup.add_breadcrumb({
+    "message": "User clicked checkout button",
+    "category": "user-action",
+    "level": "info"
+})
+
+# Set tags
+watchup.set_tag("version", "1.2.3")
+watchup.set_tags({
+    "browser": "chrome",
+    "os": "windows"
+})
+
+# Flush events before exit
+watchup.flush()
+```
+
+## Configuration
+
+```python
+watchup.init(
+    api_key="your-api-key",              # Required
+    project_id="your-project-id",        # Required
+    endpoint="https://api.watchup.com/api/v1/events",  # Optional
+    environment="production",             # Optional
+    release="1.2.3",                     # Optional
+    server_name="web-server-01",         # Optional
+    batch_interval=5000,                 # Optional (ms)
+    max_batch_size=10,                   # Optional
+    max_queue_size=100,                  # Optional
+    max_retries=3,                       # Optional
+    retry_backoff=1000,                  # Optional (ms)
+    enabled=True,                        # Optional
+    debug=False,                         # Optional
+    sample_rate=1.0,                     # Optional (0.0-1.0)
+    before_send=lambda event: event,     # Optional
+    before_breadcrumb=lambda bc: bc      # Optional
+)
+```
+
+## Decorator Usage
+
+```python
+@watchup.capture_errors
+def risky_function():
+    # Errors will be automatically captured
+    raise ValueError("Something went wrong")
+```
+
+## Context Manager
+
+```python
+with watchup.configure_scope() as scope:
+    scope.set_user({"id": "123"})
+    scope.set_tag("version", "1.0")
+    scope.capture_message("Custom message")
+```
+
+## Framework Integration
+
+### Flask
+
+```python
+from flask import Flask
+import watchup
+
+app = Flask(__name__)
+
+watchup.init(
+    api_key="your-api-key",
+    project_id="your-project-id"
+)
+
+@app.errorhandler(Exception)
+def handle_exception(e):
+    watchup.capture_error(e)
+    return "Internal Server Error", 500
+```
+
+### Django
+
+```python
+# settings.py
+import watchup
+
+watchup.init(
+    api_key="your-api-key",
+    project_id="your-project-id"
+)
+
+# middleware.py
+class WatchupMiddleware:
+    def __init__(self, get_response):
+        self.get_response = get_response
+    
+    def __call__(self, request):
+        return self.get_response(request)
+    
+    def process_exception(self, request, exception):
+        watchup.capture_error(exception)
+        return None
+
+# settings.py
+MIDDLEWARE = [
+    'yourapp.middleware.WatchupMiddleware',
+    # ... other middleware
+]
+```
+
+## API Reference
+
+### `init(api_key, project_id, **options)`
+Initialize the Watchup client.
+
+### `capture_error(error, context=None)`
+Capture an exception. Returns event ID or None.
+
+### `capture_message(message, level="info", context=None)`
+Capture a message. Returns event ID or None.
+
+### `set_user(user)`
+Set user context. Pass `None` to clear.
+
+### `add_breadcrumb(breadcrumb)`
+Add a breadcrumb to the timeline.
+
+### `set_tag(key, value)`
+Set a single tag.
+
+### `set_tags(tags)`
+Set multiple tags.
+
+### `set_extra(key, value)`
+Set extra context data.
+
+### `set_extras(extras)`
+Set multiple extra context data.
+
+### `flush(timeout=5.0)`
+Flush all queued events. Returns True if successful.
+
+### `close(timeout=5.0)`
+Close the client and cleanup resources.
+
+## License
+
+MIT License

watchup-1.0.0/README.md

@@ -0,0 +1,186 @@
+# Watchup Python SDK
+
+Official Python SDK for Watchup incident tracking.
+
+## Installation
+
+```bash
+pip install watchup
+```
+
+## Quick Start
+
+```python
+import watchup
+
+# Initialize the client
+watchup.init(
+    api_key="your-api-key",
+    project_id="your-project-id",
+    environment="production"
+)
+
+# Capture an error
+try:
+    risky_operation()
+except Exception as e:
+    watchup.capture_error(e)
+
+# Capture a message
+watchup.capture_message("User completed checkout", level="info")
+
+# Set user context
+watchup.set_user({
+    "id": "user-123",
+    "email": "user@example.com",
+    "username": "john_doe"
+})
+
+# Add breadcrumbs
+watchup.add_breadcrumb({
+    "message": "User clicked checkout button",
+    "category": "user-action",
+    "level": "info"
+})
+
+# Set tags
+watchup.set_tag("version", "1.2.3")
+watchup.set_tags({
+    "browser": "chrome",
+    "os": "windows"
+})
+
+# Flush events before exit
+watchup.flush()
+```
+
+## Configuration
+
+```python
+watchup.init(
+    api_key="your-api-key",              # Required
+    project_id="your-project-id",        # Required
+    endpoint="https://api.watchup.com/api/v1/events",  # Optional
+    environment="production",             # Optional
+    release="1.2.3",                     # Optional
+    server_name="web-server-01",         # Optional
+    batch_interval=5000,                 # Optional (ms)
+    max_batch_size=10,                   # Optional
+    max_queue_size=100,                  # Optional
+    max_retries=3,                       # Optional
+    retry_backoff=1000,                  # Optional (ms)
+    enabled=True,                        # Optional
+    debug=False,                         # Optional
+    sample_rate=1.0,                     # Optional (0.0-1.0)
+    before_send=lambda event: event,     # Optional
+    before_breadcrumb=lambda bc: bc      # Optional
+)
+```
+
+## Decorator Usage
+
+```python
+@watchup.capture_errors
+def risky_function():
+    # Errors will be automatically captured
+    raise ValueError("Something went wrong")
+```
+
+## Context Manager
+
+```python
+with watchup.configure_scope() as scope:
+    scope.set_user({"id": "123"})
+    scope.set_tag("version", "1.0")
+    scope.capture_message("Custom message")
+```
+
+## Framework Integration
+
+### Flask
+
+```python
+from flask import Flask
+import watchup
+
+app = Flask(__name__)
+
+watchup.init(
+    api_key="your-api-key",
+    project_id="your-project-id"
+)
+
+@app.errorhandler(Exception)
+def handle_exception(e):
+    watchup.capture_error(e)
+    return "Internal Server Error", 500
+```
+
+### Django
+
+```python
+# settings.py
+import watchup
+
+watchup.init(
+    api_key="your-api-key",
+    project_id="your-project-id"
+)
+
+# middleware.py
+class WatchupMiddleware:
+    def __init__(self, get_response):
+        self.get_response = get_response
+    
+    def __call__(self, request):
+        return self.get_response(request)
+    
+    def process_exception(self, request, exception):
+        watchup.capture_error(exception)
+        return None
+
+# settings.py
+MIDDLEWARE = [
+    'yourapp.middleware.WatchupMiddleware',
+    # ... other middleware
+]
+```
+
+## API Reference
+
+### `init(api_key, project_id, **options)`
+Initialize the Watchup client.
+
+### `capture_error(error, context=None)`
+Capture an exception. Returns event ID or None.
+
+### `capture_message(message, level="info", context=None)`
+Capture a message. Returns event ID or None.
+
+### `set_user(user)`
+Set user context. Pass `None` to clear.
+
+### `add_breadcrumb(breadcrumb)`
+Add a breadcrumb to the timeline.
+
+### `set_tag(key, value)`
+Set a single tag.
+
+### `set_tags(tags)`
+Set multiple tags.
+
+### `set_extra(key, value)`
+Set extra context data.
+
+### `set_extras(extras)`
+Set multiple extra context data.
+
+### `flush(timeout=5.0)`
+Flush all queued events. Returns True if successful.
+
+### `close(timeout=5.0)`
+Close the client and cleanup resources.
+
+## License
+
+MIT License

watchup-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

watchup-1.0.0/setup.py

@@ -0,0 +1,42 @@
+"""Setup configuration for Watchup Python SDK."""
+
+from setuptools import setup, find_packages
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="watchup",
+    version="1.0.0",
+    author="Watchup Ltd",
+    author_email="support@watchup.com",
+    description="Watchup SDK for Python - Error and event tracking",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/watchupltd/watchup-python",
+    packages=find_packages(exclude=["tests", "tests.*"]),
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+        "Topic :: System :: Monitoring",
+    ],
+    python_requires=">=3.7",
+    install_requires=[],
+    extras_require={
+        "dev": [
+            "pytest>=7.0.0",
+            "pytest-cov>=3.0.0",
+            "black>=22.0.0",
+            "flake8>=4.0.0",
+        ],
+    },
+)

watchup-1.0.0/tests/test_client.py

@@ -0,0 +1,65 @@
+"""Tests for client functionality."""
+
+import unittest
+import time
+from watchup import Client
+
+
+class TestClient(unittest.TestCase):
+    """Test client functionality."""
+    
+    def setUp(self):
+        """Set up test client."""
+        self.client = Client({
+            'api_key': 'test-key',
+            'project_id': 'test-project',
+            'enabled': False,  # Disable to avoid actual API calls
+            'debug': True
+        })
+    
+    def test_client_initialization(self):
+        """Test client initializes correctly."""
+        self.assertEqual(self.client.api_key, 'test-key')
+        self.assertEqual(self.client.project_id, 'test-project')
+        self.assertEqual(self.client.environment, 'production')
+    
+    def test_set_user(self):
+        """Test setting user context."""
+        self.client.set_user({
+            'id': 'user-123',
+            'email': 'test@example.com'
+        })
+        self.assertIsNotNone(self.client._user)
+        self.assertEqual(self.client._user.id, 'user-123')
+    
+    def test_set_tags(self):
+        """Test setting tags."""
+        self.client.set_tag('version', '1.0.0')
+        self.assertEqual(self.client._tags['version'], '1.0.0')
+        
+        self.client.set_tags({'env': 'test', 'region': 'us-east'})
+        self.assertEqual(self.client._tags['env'], 'test')
+        self.assertEqual(self.client._tags['region'], 'us-east')
+    
+    def test_add_breadcrumb(self):
+        """Test adding breadcrumbs."""
+        self.client.add_breadcrumb({
+            'message': 'User clicked button',
+            'category': 'user-action',
+            'level': 'info'
+        })
+        self.assertEqual(len(self.client._breadcrumbs), 1)
+        self.assertEqual(self.client._breadcrumbs[0].message, 'User clicked button')
+    
+    def test_breadcrumb_limit(self):
+        """Test breadcrumb limit."""
+        for i in range(150):
+            self.client.add_breadcrumb({
+                'message': f'Breadcrumb {i}',
+                'category': 'test'
+            })
+        self.assertLessEqual(len(self.client._breadcrumbs), 100)
+
+
+if __name__ == '__main__':
+    unittest.main()

watchup-1.0.0/tests/test_fingerprint.py

@@ -0,0 +1,55 @@
+"""Tests for fingerprinting."""
+
+import unittest
+from watchup.fingerprint import normalize_message, normalize_stack_trace, generate_fingerprint
+
+
+class TestFingerprinting(unittest.TestCase):
+    """Test fingerprinting functionality."""
+    
+    def test_normalize_message_numbers(self):
+        """Test that numbers are normalized."""
+        result = normalize_message("User 123 not found")
+        self.assertEqual(result, "User N not found")
+    
+    def test_normalize_message_hex(self):
+        """Test that hex values are normalized."""
+        result = normalize_message("Memory address 0x7f8a9b")
+        self.assertEqual(result, "Memory address HEX")
+    
+    def test_normalize_message_uuid(self):
+        """Test that UUIDs are normalized."""
+        result = normalize_message("Event 550e8400-e29b-41d4-a716-446655440000")
+        self.assertEqual(result, "Event UUID")
+    
+    def test_consistent_fingerprints(self):
+        """Test that similar errors produce same fingerprint."""
+        fp1 = generate_fingerprint(
+            "User 123 not found",
+            "File app.py:42",
+            "backend"
+        )
+        fp2 = generate_fingerprint(
+            "User 456 not found",
+            "File app.py:99",
+            "backend"
+        )
+        self.assertEqual(fp1, fp2)
+    
+    def test_different_fingerprints(self):
+        """Test that different errors produce different fingerprints."""
+        fp1 = generate_fingerprint(
+            "User not found",
+            "File app.py:42",
+            "backend"
+        )
+        fp2 = generate_fingerprint(
+            "Database connection failed",
+            "File db.py:10",
+            "backend"
+        )
+        self.assertNotEqual(fp1, fp2)
+
+
+if __name__ == '__main__':
+    unittest.main()

watchup-1.0.0/watchup/__init__.py

@@ -0,0 +1,22 @@
+"""Watchup SDK for Python - Error and event tracking."""
+
+__version__ = "1.0.0"
+
+from watchup.client import Client, init, capture_error, capture_message, set_user, add_breadcrumb, set_tag, set_tags, set_extra, set_extras, flush, close, configure_scope, capture_errors
+
+__all__ = [
+    "Client",
+    "init",
+    "capture_error",
+    "capture_message",
+    "set_user",
+    "add_breadcrumb",
+    "set_tag",
+    "set_tags",
+    "set_extra",
+    "set_extras",
+    "flush",
+    "close",
+    "configure_scope",
+    "capture_errors",
+]