chg: allow no settings for auto_report

examples/autoreport.py

@@ -0,0 +1,16 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+from pylookyloo import Lookyloo
+
+
+# lookyloo_url = "https://lookyloo.circl.lu/"
+# lookyloo_url = "https://lookyloo-demo.yoyodyne-it.eu/"
+lookyloo_url = "http://0.0.0.0:5100"
+
+lookyloo = Lookyloo(lookyloo_url)
+capture_url = lookyloo.submit(url="https://circl.lu",
+                              # auto_report=True)
+                              auto_report={"email": "[email protected]",
+                                           "comment": "This is a phishing URL targeting my bank."})
+
+print(capture_url)

pylookyloo/api.py

@@ -43,7 +43,7 @@ class CaptureSettings(TypedDict, total=False):
     referer: Optional[str]
 
     listing: Optional[bool]
-    auto_report: Optional[Dict[str, str]]
+    auto_report: Optional[Union[bool, Dict[str, str]]]
 
 
 class CompareSettings(TypedDict, total=False):
@@ -143,7 +143,7 @@ def submit(self, *, quiet: bool=False,
                viewport: Optional[Dict[str, int]]=None,
                referer: Optional[str]=None,
                listing: Optional[bool]=None,
-               auto_report: Optional[Dict[str, str]]=None
+               auto_report: Optional[Union[bool, Dict[str, str]]]=None
                ) -> str:
         ...
 
@@ -165,7 +165,7 @@ def submit(self, *, quiet: bool=False,
                viewport: Optional[Dict[str, int]]=None,
                referer: Optional[str]=None,
                listing: Optional[bool]=None,
-               auto_report: Optional[Dict[str, str]]=None
+               auto_report: Optional[Union[bool, Dict[str, str]]]=None
                ) -> str:
         '''Submit a URL to a lookyloo instance.
 
@@ -192,7 +192,7 @@ def submit(self, *, quiet: bool=False,
         :param referer: The referer URL for the capture
         :param listing: If False, the capture will be not be on the publicly accessible index page of lookyloo
         :param auto_report: If set, the capture will automatically be forwarded to an analyst (if the instance is configured this way)
-                            Dictionary with two keys:
+                            Pass True if you want to autoreport without any setting, or a dictionary with two keys:
                                 * email (required): the email of the submitter, so the analyst to get in touch
                                 * comment (optional): a comment about the capture to help the analyst
         '''

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pylookyloo"
-version = "1.22.0"
+version = "1.22.1"
 description = "Python CLI and module for Lookyloo"
 authors = ["Raphaël Vinot <[email protected]>"]
 license = "BSD-3-Clause"
@@ -39,8 +39,8 @@ Sphinx = [
 ]
 
 [tool.poetry.group.dev.dependencies]
-mypy = "^1.6.0"
-types-requests = "^2.31.0.9"
+mypy = "^1.6.1"
+types-requests = "^2.31.0.10"
 ipython = [
     {version = "<8.13.0", python = "<3.9"},
     {version = "^8.13.0", python = ">=3.9"}