feat(pygitguardian): add to_json and to_dict methods

Author: João Guerreiro

README.md

@@ -80,6 +80,19 @@ for name in glob.glob("**/*"):
 scan, status_code = client.multi_content_scan(to_scan)
 ```
 
+### Transform results to dict or JSON
+
+Any model in `py-gitguardian` can be turned to a JSON string or a dictionary using
+the `to_dict` and `to_json` methods.
+
+```py
+from pygitguardian.models import Detail
+
+detail = Detail("Invalid API Key.")
+print(detail.to_dict())
+print(detail.to_json())
+```
+
 ### Dependencies
 
 Py-gitguardian depends on these excellent libraries:

pygitguardian/__init__.py

@@ -1,26 +1,10 @@
 """PyGitGuardian API Client"""
 from .client import GGClient
-from .models import (
-    Detail,
-    DetailSchema,
-    DocumentSchema,
-    Match,
-    PolicyBreak,
-    ScanResult,
-    ScanResultSchema,
-)
 
 
 __version__ = "1.0.3"
 GGClient._version = __version__
 
 __all__ = [
-    "Detail",
-    "DetailSchema",
-    "DocumentSchema",
     "GGClient",
-    "Match",
-    "PolicyBreak",
-    "ScanResult",
-    "ScanResultSchema",
 ]

pygitguardian/models.py

@@ -152,6 +152,7 @@ def __init__(
         index_end: Optional[int] = None,
         **kwargs
     ):
+        super().__init__()
         self.match = match
         self.match_type = match_type
         self.line_start = line_start
@@ -198,6 +199,7 @@ class PolicyBreak(Base):
     SCHEMA = PolicyBreakSchema()
 
     def __init__(self, break_type: str, policy: str, matches: List[Match], **kwargs):
+        super().__init__()
         self.break_type = break_type
         self.policy = policy
         self.matches = matches