psengine 2.8.2__tar.gz → 2.8.4__tar.gz

{psengine-2.8.2 → psengine-2.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: psengine
-Version: 2.8.2
+Version: 2.8.4
 Summary: psengine is a simple, yet elegant, library for rapid development of integrations with Recorded Future.
 Keywords: API,Recorded Future,Cyber Security Engineering,Threat Intelligence
 Author: Moise Medici, Patrick Kinsella, Ernest Bartosevic
@@ -18,13 +18,14 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: typing-extensions>=4.8.0
 Requires-Dist: requests>=2.33.1
+Requires-Dist: urllib3>=2.7.0
+Requires-Dist: idna>=3.15
 Requires-Dist: jsonpath-ng>=1.5.3,<=1.8.0
 Requires-Dist: stix2~=3.0.2
 Requires-Dist: python-dateutil>=2.7.0
 Requires-Dist: more-itertools>=9.0.0,<=11.0.2
 Requires-Dist: pydantic>=2.7,<3.0.0
 Requires-Dist: pydantic-settings[toml]>=2.14.2,<2.15.0
-Requires-Dist: markdown-strings==3.4.0
 Requires-Python: >=3.10, <3.15
 Project-URL: Homepage, https://recordedfuture-professionalservices.github.io/psengine/latest/
 Project-URL: Changelog, https://recordedfuture-professionalservices.github.io/psengine/latest/CHANGELOG/

{psengine-2.8.2 → psengine-2.8.4}/psengine/analyst_notes/markdown.py

@@ -16,11 +16,10 @@ from collections import defaultdict
 from itertools import chain
 from typing import TYPE_CHECKING
 
-from markdown_strings import bold, unordered_list
-
 from ..constants import TIMESTAMP_STR
 from ..endpoints import EP_ANALYST_NOTE_LOOKUP
 from ..markdown.markdown import MarkdownMaker, divider, html_collapsible
+from ..markdown.markdown_strings import bold, unordered_list
 
 if TYPE_CHECKING:
     from ..analyst_notes import AnalystNote

{psengine-2.8.2 → psengine-2.8.4}/psengine/classic_alerts/markdown/markdown.py

@@ -15,7 +15,7 @@ import re
 from itertools import chain
 from typing import TYPE_CHECKING
 
-from markdown_strings import blockquote, bold, esc_format, link
+from ...markdown.markdown_strings import blockquote, bold, esc_format, link
 
 if TYPE_CHECKING:
     from ...classic_alerts.classic_alert import ClassicAlert

{psengine-2.8.2 → psengine-2.8.4}/psengine/markdown/markdown.py

@@ -14,11 +14,11 @@
 import html
 from typing import Annotated
 
-import markdown_strings
-from markdown_strings import header
 from pydantic import validate_call
 from typing_extensions import Doc
 
+from . import markdown_strings
+from .markdown_strings import header
 from .models import Section
 
 TITLE_HEADER_LEVEL = 2

psengine-2.8.4/psengine/markdown/markdown_strings.py

@@ -0,0 +1,163 @@
+##################################### TERMS OF USE ###########################################
+# The following code is provided for demonstration purpose only, and should not be used      #
+# without independent verification. Recorded Future makes no representations or warranties,  #
+# express, implied, statutory, or otherwise, regarding any aspect of this code or of the     #
+# information it may retrieve, and provides it both strictly “as-is” and without assuming    #
+# responsibility for any information it may retrieve. Recorded Future shall not be liable    #
+# for, and you assume all risk of using, the foregoing. By using this code, Customer         #
+# represents that it is solely responsible for having all necessary licenses, permissions,   #
+# rights, and/or consents to connect to third party APIs, and that it is solely responsible  #
+# for having all necessary licenses, permissions, rights, and/or consents to any data        #
+# accessed from any third party API.                                                         #
+##############################################################################################
+
+
+def esc_format(text, esc):
+    """Return text with markdown formatting characters escaped."""
+    if esc:
+        return str(text).replace('_', r'\_').replace('*', r'\*').replace('`', r'\`')
+    return text
+
+
+def header(header_text, header_level, style='atx', esc=True):
+    """Return a header of the specified level and style."""
+    if not isinstance(header_level, int):
+        raise TypeError('header_level must be int')
+    if not isinstance(header_text, str):
+        raise TypeError('header_text must be str')
+    if style == 'atx':
+        if not 1 <= header_level <= 6:
+            raise ValueError(f'Invalid level {header_level} for atx')
+        return f'{"#" * header_level} {esc_format(header_text, esc)}'
+    if style == 'setext':
+        if not 0 < header_level < 3:
+            raise ValueError(f'Invalid level {header_level} for setext')
+        header_character = '=' if header_level == 1 else '-'
+        header_string = (header_character * 3) + header_character * (len(header_text) - 3)
+        return f'{esc_format(header_text, esc)}\n{header_string}'
+    raise ValueError(f"Invalid style {style} (choose 'atx' or 'setext')")
+
+
+def italics(text, esc=True):
+    """Return italics formatted text."""
+    return f'_{esc_format(text, esc)}_'
+
+
+def bold(text, esc=True):
+    """Return bold formatted text."""
+    return f'**{esc_format(text, esc)}**'
+
+
+def inline_code(text):
+    """Return formatted inline code."""
+    return f'`{str(text)}`'
+
+
+def code_block(text, language=''):
+    """Return a code block, fenced if a language is specified."""
+    if language:
+        return f'```{language}\n{text}\n```'
+    return '\n'.join([f'    {item}' for item in text.split('\n')])
+
+
+def link(text, link_url, esc=True):
+    """Return an inline link."""
+    return f'[{esc_format(text, esc)}]({link_url})'
+
+
+def image(alt_text, link_url, title='', esc=True):
+    """Return an inline image."""
+    image_string = f'![{esc_format(alt_text, esc)}]({link_url})'
+    if title:
+        image_string += f' "{esc_format(title, esc)}"'
+    return image_string
+
+
+def unordered_list(text_list, esc=True):
+    """Return an unordered list from a list."""
+    return '\n'.join([f'-   {esc_format(item, esc)}' for item in text_list])
+
+
+def ordered_list(text_list, esc=True):
+    """Return an ordered list from a list."""
+    ordered_list = []
+    for number, item in enumerate(text_list):
+        ordered_list.append(
+            f'{(f"{esc_format(number + 1, esc)}.").ljust(3)} {esc_format(item, esc)}'
+        )
+    return '\n'.join(ordered_list)
+
+
+def blockquote(text, esc=True):
+    """Return a blockquote."""
+    return '\n'.join([f'> {esc_format(item, esc)}' for item in text.split('\n')])
+
+
+def horizontal_rule(length=79, style='_'):
+    """Return a horizontal rule of the specified length and style."""
+    if style not in ('_', '*'):
+        raise ValueError("Invalid style (choose '_' or '*')")
+    if length < 3:
+        raise ValueError('Length must be >= 3')
+    return style * length
+
+
+def strikethrough(text, esc=True):
+    """Return text with strike-through formatting."""
+    return f'~{esc_format(text, esc)}~'
+
+
+def task_list(task_list, esc=True):
+    """Return a task list from a 2-dimensional list of (text, completed) pairs."""
+    tasks = []
+    for item, completed in task_list:
+        tasks.append(f'- [{"X" if completed else " "}] {esc_format(item, esc)}')
+    return '\n'.join(tasks)
+
+
+def table_row(text_list, pad=None, esc=True):
+    """Return a single table row, optionally padded."""
+    if pad is None:
+        pad = [0] * len(text_list)
+    row = '|'
+    for column_number in range(len(text_list)):
+        padding = pad[column_number] + 1
+        row += (' ' + esc_format(text_list[column_number], esc)).ljust(padding) + ' |'
+    return row
+
+
+def table_delimiter_row(number_of_columns, column_lengths=None):
+    """Return a delimiter row for use in a table."""
+    if column_lengths is None:
+        column_lengths = [0] * number_of_columns
+    if number_of_columns != len(column_lengths):
+        raise ValueError('number_of_columns must be the number of columns in column_lengths')
+    delimiter_row = [
+        '---' + '-' * (column_lengths[column_number] - 3)
+        for column_number in range(number_of_columns)
+    ]
+    return table_row(delimiter_row)
+
+
+def table(table_list):
+    """Return a formatted table generated from a 2-dimensional list of columns."""
+    number_of_columns = len(table_list)
+    number_of_rows_in_column = [len(column) for column in table_list]
+    string_list = [[str(cell) for cell in column] for column in table_list]
+    column_lengths = [len(max(column, key=len)) for column in string_list]
+    table = []
+
+    row_list = [column[0] for column in string_list]
+    table.append(table_row(row_list, pad=column_lengths))
+
+    table.append(table_delimiter_row(len(column_lengths), column_lengths=column_lengths))
+
+    for row in range(1, max(number_of_rows_in_column)):
+        row_list = []
+        for column_number in range(number_of_columns):
+            if number_of_rows_in_column[column_number] > row:
+                row_list.append(string_list[column_number][row])
+            else:
+                row_list.append('')
+        table.append(table_row(row_list, pad=column_lengths))
+    return '\n'.join(table)

{psengine-2.8.2 → psengine-2.8.4}/psengine/playbook_alerts/markdown/markdown.py

@@ -11,12 +11,11 @@
 # accessed from any third party API.                                                         #
 ##############################################################################################
 
-from markdown_strings import bold, link
-
 from ...constants import TIMESTAMP_STR, TRUNCATE_COMMENT
 from ...markdown import (
     MarkdownMaker,
 )
+from ...markdown.markdown_strings import bold, link
 from ..pa_category import PACategory
 from .markdown_code_repo import _code_repo_markdown
 from .markdown_cyber_vulnerability import _cyber_vulnerability_markdown

{psengine-2.8.2 → psengine-2.8.4}/psengine/playbook_alerts/markdown/markdown_code_repo.py

@@ -14,10 +14,9 @@
 from collections import defaultdict
 from typing import TYPE_CHECKING
 
-from markdown_strings import blockquote, bold
-
 from ...constants import TIMESTAMP_STR
 from ...markdown import MarkdownMaker, clean_text, divider, html_textarea
+from ...markdown.markdown_strings import blockquote, bold
 
 if TYPE_CHECKING:
     from ...playbook_alerts.playbook_alerts import PBA_CodeRepoLeakage

{psengine-2.8.2 → psengine-2.8.4}/psengine/playbook_alerts/markdown/markdown_cyber_vulnerability.py

@@ -14,14 +14,13 @@
 import itertools
 from typing import TYPE_CHECKING
 
-from markdown_strings import bold, unordered_list
-
 from ...analyst_notes import AnalystNote
 from ...analyst_notes.markdown import _cleanup_insikt_note_text
 from ...constants import TIMESTAMP_STR
 from ...enrich.lookup import CVSS, CVSSV3, EnrichmentData
 from ...markdown import MarkdownMaker
 from ...markdown.markdown import divider, header, html_collapsible
+from ...markdown.markdown_strings import bold, unordered_list
 
 if TYPE_CHECKING:
     from ...playbook_alerts.playbook_alerts import PBA_CyberVulnerability

{psengine-2.8.2 → psengine-2.8.4}/psengine/playbook_alerts/markdown/markdown_domain_abuse.py

@@ -14,12 +14,11 @@
 import base64
 from typing import TYPE_CHECKING
 
-from markdown_strings import bold
-
 from ...constants import TIMESTAMP_STR
 from ...helpers import FormattingHelpers
 from ...markdown import MarkdownMaker
 from ...markdown.markdown import divider, table_from_rows
+from ...markdown.markdown_strings import bold
 from ..models.pba_domain_abuse import ValueServer
 
 if TYPE_CHECKING:

{psengine-2.8.2 → psengine-2.8.4}/psengine/playbook_alerts/markdown/markdown_geopolitics_facility.py

@@ -15,9 +15,8 @@ import base64
 from datetime import datetime
 from typing import TYPE_CHECKING
 
-from markdown_strings import bold, link
-
 from ...markdown import MarkdownMaker, divider
+from ...markdown.markdown_strings import bold, link
 
 if TYPE_CHECKING:
     from ...playbook_alerts.playbook_alerts import PBA_GeopoliticsFacility

{psengine-2.8.2 → psengine-2.8.4}/psengine/playbook_alerts/markdown/markdown_identity_exposure.py

@@ -13,11 +13,10 @@
 
 from typing import TYPE_CHECKING
 
-from markdown_strings import bold, unordered_list
-
 from ...constants import TIMESTAMP_STR
 from ...markdown import MarkdownMaker
 from ...markdown.markdown import divider
+from ...markdown.markdown_strings import bold, unordered_list
 
 if TYPE_CHECKING:
     from ...playbook_alerts.playbook_alerts import PBA_IdentityNovelExposure

{psengine-2.8.2 → psengine-2.8.4}/psengine/playbook_alerts/markdown/markdown_malware_report.py

@@ -13,10 +13,9 @@
 
 from typing import TYPE_CHECKING
 
-from markdown_strings import bold, header
-
 from ...markdown import MarkdownMaker, divider
 from ...markdown.markdown import html_collapsible
+from ...markdown.markdown_strings import bold, header
 
 if TYPE_CHECKING:
     from ...playbook_alerts.playbook_alerts import PBA_MalwareReport

{psengine-2.8.2 → psengine-2.8.4}/psengine/playbook_alerts/markdown/markdown_third_party_risk.py

@@ -15,14 +15,13 @@ import itertools
 from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
-from markdown_strings import bold, unordered_list
-
 from ...analyst_notes import AnalystNote
 from ...analyst_notes.markdown import _cleanup_insikt_note_text
 from ...constants import TIMESTAMP_STR
 from ...enrich import EnrichedIP, EnrichmentData, SOAREnrichOut
 from ...markdown import MarkdownMaker
 from ...markdown.markdown import divider, header, html_collapsible
+from ...markdown.markdown_strings import bold, unordered_list
 from ..models.pba_third_party_risk import TPRAssessment
 
 if TYPE_CHECKING:

{psengine-2.8.2 → psengine-2.8.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "psengine"
-version = "2.8.2"
+version = "2.8.4"
 readme = "README.md"
 license = "MIT"
 requires-python = ">=3.10, <3.15"
@@ -29,13 +29,14 @@ classifiers=[
 dependencies = [ 
     "typing_extensions >= 4.8.0", 
     "requests>=2.33.1",
+    "urllib3>=2.7.0",
+    "idna>=3.15",
     "jsonpath_ng>=1.5.3, <=1.8.0",
     "stix2~=3.0.2",
     "python-dateutil>=2.7.0",
     "more-itertools>=9.0.0, <=11.0.2",
     "pydantic>=2.7, <3.0.0",
     "pydantic-settings[toml]>=2.14.2,<2.15.0",
-    "markdown-strings==3.4.0"
 ]
 
 
@@ -61,11 +62,12 @@ docs = [
     "mike>=2.1.4,<2.3.0",
     "mkdocs~=1.6.1",
     "mkdocs-material>=9.7.6,<9.8.0",
-    "mkdocstrings[python]>=0.18",
+    "mkdocstrings[python]>=1.0.4",
     "griffe-typingdoc>=0.2.8,<0.4.0",
     "mkdocs-codeinclude-plugin~=0.2.1",
     "markdown-include~=0.8.1",
     "mkdocs-exclude~=1.0.2",
+    "pymdown-extensions~=10.21.3",
 
     # Tools for examples
     "rich==15.0.0",