!32 feat(ProbelyAPIClient): [#32] Add user-agent to requests Closes #32

Author: João Silva

examples/call_targets_sdk.py

@@ -0,0 +1,21 @@
+import json
+from typing import List
+
+from probely_cli import list_targets, Probely
+from probely_cli.exceptions import ProbelyException
+
+if __name__ == "__main__":
+
+    # You can config programmatically
+    Probely.init(api_key="your_api_key")
+
+    targets_list: List[dict]
+
+    try:
+        targets_list = list_targets()
+
+        for target in targets_list:
+            print(json.dumps(target, indent=4))
+
+    except ProbelyException as probely_exception:
+        print("Probely sdk error:", probely_exception)

examples/targets.py

@@ -1,9 +1,23 @@
-# from probely_cli.sdk.targets import list_targets
-#
-# from .exceptions import *
-# from .sdk.client import Probely
+from .sdk.client import Probely
+from .sdk.targets import (
+    list_targets,
+    retrieve_target,
+    retrieve_targets,
+    delete_targets,
+    add_target,
+    update_target,
+    update_targets,
+)
+from .version import __version__
 
-# __all__ = [
-#     # defines behaviour of "from probely_cli import *"
-#     # TODO: seems to be a good practice
-# ]
+__all__ = [
+    "Probely",
+    "add_target",
+    "list_targets",
+    "retrieve_target",
+    "retrieve_targets",
+    # "delete_target",
+    "delete_targets",
+    "update_target",
+    "update_targets",
+]

probely_cli/__init__.py

@@ -4,7 +4,7 @@
 
 from rich.console import Console
 
-from .app import CliApp
+from .app import CLIApp
 from .commands.parsers import build_cli_parser
 
 logger = logging.getLogger(__name__)
@@ -25,7 +25,7 @@ def app():
     args.console = console
     args.err_console = err_console
 
-    cli_app = CliApp(args)
+    cli_app = CLIApp(args)
 
     from .. import settings
 

probely_cli/cli/__init__.py

@@ -1,19 +1,21 @@
 import argparse
 import logging
 
-from probely_cli import settings
+from probely_cli import settings, Probely
 from probely_cli.exceptions import ProbelyException, ProbelyCLIValidation
 
 logger = logging.getLogger(__name__)
 
 
-class CliApp:
+class CLIApp:
     args: argparse.Namespace
 
     def __init__(self, args: argparse.Namespace):
+        settings.IS_CLI = True
+
         args_dict = vars(args)
         if args_dict.get("api_key"):
-            settings.PROBELY_API_KEY = args.api_key
+            Probely.init(api_key=args_dict.get("api_key"))
 
         if args_dict.get("debug"):
             settings.IS_DEBUG_MODE = True

probely_cli/cli/app.py

@@ -1,15 +1,12 @@
 import logging
-from pathlib import Path
 
-from rich.console import Console
-from probely_cli.sdk.targets import add_target
+from probely_cli.cli.commands.apply.schemas import ApplyFileSchema
+from probely_cli.cli.common import validate_and_retrieve_yaml_content
 from probely_cli.exceptions import (
     ProbelyException,
     ProbelyBadRequest,
 )
-from probely_cli.cli.commands.apply.schemas import ApplyFileSchema
-from probely_cli.cli.common import validate_and_retrieve_yaml_content
-
+from probely_cli.sdk.targets import add_target
 
 logger = logging.getLogger(__name__)
 

probely_cli/cli/commands/apply/apply.py

@@ -10,16 +10,14 @@
 from rich.table import Table
 
 from probely_cli.cli.commands.findings.schemas import FindingsApiFiltersSchema
-from probely_cli.cli.common import (
-    FindingSeverityEnum,
-    OutputEnum,
-)
+from probely_cli.cli.common import OutputEnum
 from probely_cli.cli.formatters import (
     get_printable_enum_value,
     get_printable_date,
     get_printable_labels,
 )
 from probely_cli.exceptions import ProbelyCLIValidation
+from probely_cli.sdk.common import FindingSeverityEnum
 from probely_cli.sdk.findings import list_findings
 from probely_cli.sdk.findings import retrieve_findings
 

probely_cli/cli/commands/findings/get.py

@@ -5,9 +5,8 @@
 from probely_cli.cli.commands.findings.get import findings_get_command_handler
 from probely_cli.cli.common import (
     show_help,
-    FindingSeverityEnum,
-    FindingStateEnum,
 )
+from probely_cli.sdk.common import FindingSeverityEnum, FindingStateEnum
 from probely_cli.settings import TRUTHY_VALUES, FALSY_VALUES
 
 

probely_cli/cli/commands/findings/parsers.py

@@ -2,10 +2,9 @@
 
 from probely_cli.cli.common import (
     ProbelyCLIEnumField,
-    FindingSeverityEnum,
     ProbelyCLIBaseFiltersSchema,
-    FindingStateEnum,
 )
+from probely_cli.sdk.common import FindingSeverityEnum, FindingStateEnum
 
 
 class FindingsApiFiltersSchema(ProbelyCLIBaseFiltersSchema):

probely_cli/cli/commands/findings/schemas.py

@@ -1,11 +1,13 @@
 import argparse
+
 from rich_argparse import RichHelpFormatter
 
 from probely_cli.cli.commands.scans.cancel import scans_cancel_command_handler
 from probely_cli.cli.commands.scans.get import scans_get_command_handler
-from probely_cli.cli.commands.scans.resume import scans_resume_command_handler
 from probely_cli.cli.commands.scans.pause import scans_pause_command_handler
-from probely_cli.cli.common import ScanStatusEnum, show_help
+from probely_cli.cli.commands.scans.resume import scans_resume_command_handler
+from probely_cli.cli.common import show_help
+from probely_cli.sdk.common import ScanStatusEnum
 
 
 def build_scan_filters_parser() -> argparse.ArgumentParser: