pjdev-sn-sdk 4.6.4__tar.gz

pjdev_sn_sdk-4.6.4/.gitignore

@@ -0,0 +1,165 @@
+.DS_Store
+.idea
+
+!**/.gitkeep
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

pjdev_sn_sdk-4.6.4/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026-present Chris O'Neill <chris@purplejay.io>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

pjdev_sn_sdk-4.6.4/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: pjdev-sn-sdk
+Version: 4.6.4
+Project-URL: Documentation, https://gitlab.purplejay.io/keystone/python/-/tree/main/pjdev-pydantic/README.md
+Project-URL: Issues, https://gitlab.purplejay.io/keystone/python/-/issues
+Project-URL: Source, https://gitlab.purplejay.io/keystone/python
+Author-email: Purple Jay LLC <developers@purplejay.io>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.12
+Requires-Dist: httpx
+Requires-Dist: loguru
+Requires-Dist: pydantic-settings>=2.13.1
+Requires-Dist: pydantic>=2.12.5
+Provides-Extra: dev
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytz; extra == 'test'
+Description-Content-Type: text/markdown
+
+# pjdev-sn-sdk
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pjdev-sn-sdk.svg)](https://pypi.org/project/pjdev-sn-sdk)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pjdev-sn-sdk.svg)](https://pypi.org/project/pjdev-sn-sdk)
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+```console
+pip install pjdev-sn-sdk
+```
+
+## License
+
+`pjdev-sn-sdk` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

pjdev_sn_sdk-4.6.4/README.md

@@ -0,0 +1,21 @@
+# pjdev-sn-sdk
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pjdev-sn-sdk.svg)](https://pypi.org/project/pjdev-sn-sdk)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pjdev-sn-sdk.svg)](https://pypi.org/project/pjdev-sn-sdk)
+
+-----
+
+## Table of Contents
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+```console
+pip install pjdev-sn-sdk
+```
+
+## License
+
+`pjdev-sn-sdk` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

pjdev_sn_sdk-4.6.4/pyproject.toml

@@ -0,0 +1,73 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pjdev-sn-sdk"
+dynamic = ["version"]
+description = ''
+readme = "README.md"
+requires-python = ">=3.12"
+license = "MIT"
+keywords = []
+authors = [
+  { name = "Purple Jay LLC", email = "developers@purplejay.io" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+  "httpx",
+  "loguru",
+  "pydantic-settings>=2.13.1",
+  "pydantic>=2.12.5",
+]
+
+[project.optional-dependencies]
+dev = [
+    "ruff",
+]
+
+test = [
+    "pytest",
+    "coverage",
+    "pytz"
+]
+
+[project.urls]
+Documentation = "https://gitlab.purplejay.io/keystone/python/-/tree/main/pjdev-pydantic/README.md"
+Issues = "https://gitlab.purplejay.io/keystone/python/-/issues"
+Source = "https://gitlab.purplejay.io/keystone/python"
+
+[tool.hatch.version]
+path = "src/pjdev_sn_sdk/__about__.py"
+
+[tool.hatch.envs.types]
+extra-dependencies = [
+  "mypy>=1.0.0",
+]
+[tool.hatch.envs.types.scripts]
+check = "mypy --install-types --non-interactive {args:src/pjdev_sn_sdk tests}"
+
+[tool.coverage.run]
+source_pkgs = ["pjdev_sn_sdk", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/pjdev_sn_sdk/__about__.py",
+]
+
+[tool.coverage.paths]
+pjdev_sn_sdk = ["src/pjdev_sn_sdk", "*/pjdev-sn-sdk/src/pjdev_sn_sdk"]
+tests = ["tests", "*/pjdev-sn-sdk/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]

pjdev_sn_sdk-4.6.4/src/pjdev_sn_sdk/__about__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2026-present Chris O'Neill <chris@purplejay.io>
+#
+# SPDX-License-Identifier: MIT
+__version__ = "4.6.4"

pjdev_sn_sdk-4.6.4/src/pjdev_sn_sdk/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2026-present Chris O'Neill <chris@purplejay.io>
+#
+# SPDX-License-Identifier: MIT

pjdev_sn_sdk-4.6.4/src/pjdev_sn_sdk/api_utilities.py

@@ -0,0 +1,161 @@
+import asyncio
+import time
+from functools import wraps
+from typing import Optional, List, Any
+
+import httpx
+from httpx import HTTPStatusError
+from loguru import logger
+
+
+async def log_server_addr(response):
+    network_stream_ext = response.extensions["network_stream"]
+    logger.debug(f"Client IP, Port: {network_stream_ext.get_extra_info('client_addr')}")
+    logger.debug(f"Server IP, Port: {network_stream_ext.get_extra_info('server_addr')}")
+
+
+async def log_request_headers(request):
+    header_keys = [k for k in request.headers.keys()]
+    logger.debug("Request event hook - Headers: " + " | ".join(header_keys))
+    logger.debug(
+        f"Request event hook: {request.method} {request.url} - Waiting for response"
+    )
+
+
+async def log_response_headers(response):
+    request = response.request
+    header_keys = [k for k in response.headers.keys()]
+    logger.debug("Request event hook - Headers: " + " | ".join(header_keys))
+    logger.debug(
+        f"Response event hook: Content-Type -> {response.headers.get('content-type')}"
+    )
+    logger.debug(
+        f"Response event hook: Content-encoding -> {response.headers.get('content-encoding')}"
+    )
+    logger.debug(
+        f"Response event hook: transfer-encoding -> {response.headers.get('transfer-encoding')}"
+    )
+    logger.debug(f"Response event hook: Server -> {response.headers.get('server')}")
+    logger.debug(
+        f"Response event hook: {request.method} {request.url} - Status {response.status_code}"
+    )
+
+
+def get_error_message(eg: ExceptionGroup) -> str:
+    error_messages = []
+    for e in eg.exceptions:
+        if isinstance(e, httpx.HTTPStatusError):
+            error_messages.append(f"{e.response.status_code} -> " + e.response.text)
+        else:
+            error_messages.append(str(e))
+    error = " | ".join(f"{e}" for e in error_messages)
+    logger.error(error)
+
+    return error
+
+
+def retry_http(max_attempts: int, delay_seconds: int):
+    def decorator(func):
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            attempts = 0
+            while attempts < max_attempts:
+                try:
+                    return func(*args, **kwargs)
+                except Exception as e:
+                    attempts += 1
+                    logger.warning(e)
+                    logger.warning(f"Attempt {attempts}/{max_attempts} failed: {e}")
+                    time.sleep(delay_seconds**attempts)
+            raise Exception(f"Failed after {max_attempts} attempts")
+
+        return wrapper
+
+    return decorator
+
+
+def async_retry_http(
+    max_attempts: int,
+    delay_seconds: int,
+    default_value: Optional[Any] = None,
+    status_codes_to_ignore: Optional[List[int]] = None,
+):
+    def decorator(func):
+        @wraps(func)
+        async def wrapper(*args, **kwargs):
+            attempts = 0
+            exceptions = []
+
+            while attempts < max_attempts:
+                try:
+                    return await func(*args, **kwargs)
+                except HTTPStatusError as e:
+                    logger.warning(e)
+                    logger.warning(
+                        f"{e.response.status_code}: {e.response.reason_phrase}"
+                    )
+                    logger.warning(f"{e.response.text}")
+                    exceptions.append(e)
+                    if (
+                        status_codes_to_ignore
+                        and e.response.status_code in status_codes_to_ignore
+                    ):
+                        break
+                except Exception as e:
+                    logger.warning("unexpected exception")
+                    logger.warning(e)
+                    exceptions.append(e)
+
+                attempts += 1
+                if attempts == max_attempts:
+                    break
+                logger.warning(f"Attempt {attempts}/{max_attempts} failed")
+                total_delay = delay_seconds**attempts
+                logger.warning(f"Retrying in {total_delay} seconds...")
+                await asyncio.sleep(total_delay)
+            if default_value is None:
+                raise ExceptionGroup(
+                    f"Failed after {max_attempts} attempts", exceptions
+                )
+            logger.error(f"Failed after {max_attempts} attempts")
+            return default_value
+
+        return wrapper
+
+    return decorator
+
+
+def record_time(log: bool = False):
+    def decorator(func):
+        if asyncio.iscoroutinefunction(func):
+
+            @wraps(func)
+            async def wrap_func(*args, **kwargs):
+                t1 = time.time()
+                result = await func(*args, **kwargs)
+                t2 = time.time()
+                if log:
+                    logger.info(
+                        f"Function {func.__name__!r} executed in {(t2 - t1):.2f}s"
+                    )
+                return result
+
+            return wrap_func
+
+        else:
+
+            @wraps(func)
+            def wrap_func(*args, **kwargs):
+                t1 = time.time()
+                result = func(*args, **kwargs)
+                t2 = time.time()
+                if log:
+                    logger.info(
+                        f"Function {func.__name__!r} executed in {(t2 - t1):.2f}s"
+                    )
+
+                return result
+
+            return wrap_func
+
+    return decorator

pjdev_sn_sdk-4.6.4/src/pjdev_sn_sdk/config_service.py

@@ -0,0 +1,19 @@
+from pathlib import Path
+from typing import Optional
+
+from pjdev_sn_sdk.models import Config
+
+__ctx = {}
+
+
+def get_config() -> Config:
+    return __ctx["config"]
+
+
+async def init(env_path: Optional[Path] = None) -> None:
+    Config.model_config.update(env_file=env_path)
+    __ctx["config"] = Config()
+
+    if __ctx["config"].output_path is None:
+        __ctx["config"].output_path = env_path / "output"
+

pjdev_sn_sdk-4.6.4/src/pjdev_sn_sdk/control_parsing_service.py

@@ -0,0 +1,98 @@
+import re
+from typing import Optional
+
+from loguru import logger
+
+
+def extract_control(ap: Optional[str]) -> Optional[str]:
+    """
+    Extract the NIST 800-53 control_id from an assessment procedure (ap) value.
+
+    What it does:
+    - Accepts a wide variety of AP formats (case-insensitive).
+    - Removes [r5] revision markers (wherever they appear).
+    - Parses the control family (e.g., AC) and control number (e.g., 2), removing leading zeros.
+    - Captures only the immediate numeric enhancement in parentheses (e.g., (3)).
+    - Ignores objective letters like (a), (b), roman numerals, dot suffixes like .01, and other notes.
+
+    Examples:
+    - "AC-2(3)(a)"        -> "AC-02(03)"
+    - "[r5] ac-02 (03)"   -> "AC-02(03)"
+    - "PM-16 (01) (b)"    -> "PM-16(01)"
+    - "RA-5(5)(A)(1)"     -> "RA-05(05)"
+    - "SC-7 (12).01(a)"   -> "SC-07(12)"
+    - "AU-3"              -> "AU-03"
+    - "invalid"           -> None
+
+    :param ap: The assessment procedure string.
+    :return: The related control_id (e.g., 'AC-2' or 'AC-2(3)') or None if it can't be parsed.
+    """
+    if not ap:
+        return None
+
+    s = ap.strip()
+    if not s:
+        return None
+
+    # Remove revision markers like [r5] anywhere in the string (case-insensitive).
+    s = re.sub(r"\[\s*r?\s*5\s*\]", "", s, flags=re.IGNORECASE)
+
+    # Match the base control family and number (e.g., AC-2, CM-06, etc.)
+    # NOTE: Use a negative lookahead to avoid requiring a word boundary after the number.
+    # This allows inputs like "CA-05b" to match the base "CA-05" while excluding trailing digits.
+    base_match = re.search(r"(?i)\b([A-Z]{2})\s*-\s*0*([0-9]{1,3})(?!\d)", s)
+
+    if not base_match:
+        logger.debug(f"Could not find control family and number in AP: {ap}")
+        return None
+
+    family = base_match.group(1).upper()
+    number = str(int(base_match.group(2)))  # strip any leading zeros by int conversion
+    control_id = f"{family}-{'0' if len(number) == 1 else ''}{number}"
+
+    # Starting right after the base match, capture immediate numeric parentheses like (03) -> (3).
+    idx = base_match.end()
+    paren_token = re.compile(r"\s*\(\s*([^)]+)\s*\)")
+
+    while True:
+        m = paren_token.match(s, idx)
+        if not m:
+            break
+
+        token = m.group(1)
+
+        # Only accept purely numeric tokens as part of the control identifier.
+        # Stop at the first non-numeric token (e.g., letters like (a), roman numerals, etc.).
+        if re.fullmatch(r"0*\d+", token):
+            sub_number = f"{int(token)}"
+            control_id += f"({'0' if len(sub_number) == 1 else ''}{sub_number})"  # normalize 0-padded numbers
+            idx = m.end()
+            # Continue in case there is another numeric enhancement directly chained.
+            continue
+        else:
+            break
+
+    return control_id
+
+
+def strip_leading_zeros_after_dash_or_dot(s: str) -> str:
+    return re.sub(r"(?<=[-.(])0+(?=\d)", "", s)
+
+
+def extract_control_requirement(ap: Optional[str]) -> Optional[str]:
+    if not ap:
+        return None
+
+    control_id = extract_control(ap=ap)
+    if not control_id:
+        return None
+
+    sn_control_id = strip_leading_zeros_after_dash_or_dot(control_id)
+    stripped_ap = strip_leading_zeros_after_dash_or_dot(ap).upper()
+
+    part = stripped_ap.removeprefix(sn_control_id).removeprefix(".").split(".")[0]
+
+    if not part:
+        return None
+
+    return f"{sn_control_id}.{part.strip().lower()}"