From 5a30b1a784d29ef839e48bc89e038015b83db2a3 Mon Sep 17 00:00:00 2001
From: Michael Beck <ich@mbeck.cologne>
Date: Fri, 11 Apr 2025 14:42:43 +0200
Subject: [PATCH] adds logging to dev info

---
 DEVELOPMENT | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 DEVELOPMENT

diff --git a/DEVELOPMENT b/DEVELOPMENT
new file mode 100644
index 0000000..a739406
--- /dev/null
+++ b/DEVELOPMENT
@@ -0,0 +1,65 @@
+## How to use the logger
+
+### GUI Interactions:
+
+```python
+ActivityLog.log_gui_interaction(
+    action="view_paper_details",
+    description="User viewed paper details",
+    paper_id=123
+)
+```
+
+### Configuration Changes:
+
+```python
+ActivityLog.log_gui_interaction(
+    action="view_paper_details",
+    description="User viewed paper details",
+    paper_id=123
+)
+```
+
+### Scraper Commands:
+
+```python
+ActivityLog.log_scraper_command(
+    action="start_scraper", 
+    status="running"
+)
+```
+
+### Scraper Activities:
+
+```python
+ActivityLog.log_scraper_activity(
+    action="download_paper",
+    paper_id=123,
+    status="success",
+    description="Paper downloaded successfully",
+    file_path="/papers/123.pdf"
+)
+```
+
+### Error Logging:
+
+```python
+# Simple error
+ActivityLog.log_error(
+    error_message="Failed to connect to API",
+    severity=ErrorSeverity.WARNING.value,
+    source="api_client"
+)
+
+# Logging an exception
+try:
+    result = some_risky_operation()
+except Exception as e:
+    ActivityLog.log_error(
+        error_message="Operation failed",
+        exception=e,
+        severity=ErrorSeverity.ERROR.value,
+        source="data_processor",
+        paper_id=paper_id
+    )
+```
\ No newline at end of file