intuned-runtime 1.0.0__tar.gz

intuned_runtime-1.0.0/LICENSE

@@ -0,0 +1,42 @@
+Acceptance
+By using the software, you agree to all of the terms and conditions below.
+
+Copyright License
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below.
+
+Limitations
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+Patents
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+Notices
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+No Other Rights
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+Termination
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+No Liability
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+Definitions
+The licensor is the entity offering these terms, and the software is the software the licensor makes available under these terms, including any portion of it.
+
+you refers to the individual or entity agreeing to these terms.
+
+your company is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. control means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+your licenses are all the licenses granted to you for the software under these terms.
+
+use means anything you do with the software requiring one of your licenses.
+
+trademark means trademarks, service marks, and similar rights.

intuned_runtime-1.0.0/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.3
+Name: intuned-runtime
+Version: 1.0.0
+Summary: Runtime commands for Intuned platform Python scrapers
+License: Elastic-2.0
+Keywords: runtime,intuned
+Author: Intuned Developers
+Author-email: engineering@intunedhq.com
+Requires-Python: >=3.9,<4.0
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: aiofiles (>=24.1.0,<25.0.0)
+Requires-Dist: arguably (>=1.3.0,<2.0.0)
+Requires-Dist: gitpython (>=3.1.43,<4.0.0)
+Requires-Dist: httpx (>=0.23.0,<1)
+Requires-Dist: more-termcolor (>=1.1.3,<2.0.0)
+Requires-Dist: pathspec (>=0.12.1,<0.13.0)
+Requires-Dist: pydantic (>=2.10.6,<3.0.0)
+Requires-Dist: pyright (>=1.1.387,<2.0.0)
+Requires-Dist: python-dotenv (==1.0.1)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: ruff (>=0.7.2,<0.8.0)
+Requires-Dist: semver (>=3.0.4,<4.0.0)
+Requires-Dist: tenacity (>=8.5.0,<9.0.0)
+Requires-Dist: toml (>=0.10.2,<0.11.0)
+Requires-Dist: waitress (>=3.0.1,<4.0.0)
+Description-Content-Type: text/markdown
+
+# Intuned Python Runtime
+
+Runtime commands for Intuned platform Python automations.
+
+## Dependencies
+
+- Requires Python 3.12 or higher.
+- Install poetry: `pip install poetry`
+- Install dependencies: `poetry install`
+- Activate virtual environment: `poetry shell`
+- Now you have access to `intuned` cli from within project.
+
+## Install globally
+
+- This project can be installed globally on the system to use `intuned` cli anywhere
+- Make sure you are not in a virtual environment. `which python` should point to system python.
+  - If you are, `deactivate` to exit virtual environment. Or open in an external terminal (from outside vscode if it doesn't work)
+- Run `pip install -e .` from the root of the project.
+
+## Commands
+
+All commands have `-h` flag to show help.
+
+### `intuned init`
+
+- Initializes a project. Creates `pyproject.toml`, `Intuned.json` and `README.md` files.
+- Prompts for confirmation for each file that already exists.
+- Options:
+  - `--yes/-y` flag to overwrite all files.
+  - `--no/-n` flag to not overwrite any files.
+
+### `intuned publish-packages`
+
+- Publishes packages to `python-packages` repository.
+- Options:
+  - `--sdk` flag to publish SDK package. Creates `sdk-<version>` and `sdk-latest` tags for the published version.
+  - `--runtime` flag to publish runtime package. Creates `runtime-<version>` and `runtime-latest` tags for the published version.
+  - `--overwrite` flag to overwrite the existing version if it exists.
+  - `--show-diff` flag to show the diff of the package before publishing. You need to configure a diff tool to be used for `git difftool` command in your git config. [How to configure VS Code as a diff tool](https://www.roboleary.net/vscode/2020/09/15/vscode-git.html#tldr).
+  - `--no-latest` flag to not release `latest` tag for the published version.
+- Uses the version specified in `pyproject.toml` of each package respectively.
+- Uses WebApp directory specified in `WEBAPP_REPO` environment variable or tries to resolve it (only works if installed globally with `-e` flag).
+- Uses `python-packages` directory to be sister to WebApp directory `<webapp path>/../python-packages`.
+- These packages are used on deployed apps.
+
+### `intuned project run`
+
+- Runs the project.
+  - `--mode` to specify the mode to run. Default is `sample`.
+    - `--mode sample` extends a sample of payloads to run.
+    - `--mode full` runs all extended payloads.
+    - `--mode single` runs the initial API only.
+  - `--api-name <name>` to specify the initial API to run. Defaults to `default`
+  - `--params <params json>` to specify the parameters to the initial API.
+  - `--sample-config-str '{<api name>: <sample size>, ...}` to specify the sample config. Only used with `--mode sample`.
+  - `--no-headless` to disable headless mode.
+
+### `intuned project deploy`
+
+- Deploys a project and starts a default job.
+- Options:
+  - `--workspace-info '{"environment_url": <>, "workspace_id": <>, "api_key": <>}'` to specify the workspace info.
+  - `--workspace-info-path` to specify the path to a JSON file containing workspace info.
+  - `-y/--yes` to skip confirmation.
+  - `--project-name` to specify the project name. Resolves the name if not provided.
+- Resolves `.gitignore` from current/parent directories to decide what to deploy.
+- Resolves `.env` from current/parent directories to get environment variables to deploy.
+- Resolves project name from the current/parent directory name if not provided.
+
+### `intuned project serve`
+
+- Serves the project as an HTTP server.
+- Options:
+  - `--env development/production` to specify the environment to run the server.
+    - Development runs using Flask's development server.
+    - Production runs using Waitress.
+  - `--debug` to run the development server in debug mode. Not supported in production.
+- This is used on deployed apps.
+

intuned_runtime-1.0.0/README.md

@@ -0,0 +1,78 @@
+# Intuned Python Runtime
+
+Runtime commands for Intuned platform Python automations.
+
+## Dependencies
+
+- Requires Python 3.12 or higher.
+- Install poetry: `pip install poetry`
+- Install dependencies: `poetry install`
+- Activate virtual environment: `poetry shell`
+- Now you have access to `intuned` cli from within project.
+
+## Install globally
+
+- This project can be installed globally on the system to use `intuned` cli anywhere
+- Make sure you are not in a virtual environment. `which python` should point to system python.
+  - If you are, `deactivate` to exit virtual environment. Or open in an external terminal (from outside vscode if it doesn't work)
+- Run `pip install -e .` from the root of the project.
+
+## Commands
+
+All commands have `-h` flag to show help.
+
+### `intuned init`
+
+- Initializes a project. Creates `pyproject.toml`, `Intuned.json` and `README.md` files.
+- Prompts for confirmation for each file that already exists.
+- Options:
+  - `--yes/-y` flag to overwrite all files.
+  - `--no/-n` flag to not overwrite any files.
+
+### `intuned publish-packages`
+
+- Publishes packages to `python-packages` repository.
+- Options:
+  - `--sdk` flag to publish SDK package. Creates `sdk-<version>` and `sdk-latest` tags for the published version.
+  - `--runtime` flag to publish runtime package. Creates `runtime-<version>` and `runtime-latest` tags for the published version.
+  - `--overwrite` flag to overwrite the existing version if it exists.
+  - `--show-diff` flag to show the diff of the package before publishing. You need to configure a diff tool to be used for `git difftool` command in your git config. [How to configure VS Code as a diff tool](https://www.roboleary.net/vscode/2020/09/15/vscode-git.html#tldr).
+  - `--no-latest` flag to not release `latest` tag for the published version.
+- Uses the version specified in `pyproject.toml` of each package respectively.
+- Uses WebApp directory specified in `WEBAPP_REPO` environment variable or tries to resolve it (only works if installed globally with `-e` flag).
+- Uses `python-packages` directory to be sister to WebApp directory `<webapp path>/../python-packages`.
+- These packages are used on deployed apps.
+
+### `intuned project run`
+
+- Runs the project.
+  - `--mode` to specify the mode to run. Default is `sample`.
+    - `--mode sample` extends a sample of payloads to run.
+    - `--mode full` runs all extended payloads.
+    - `--mode single` runs the initial API only.
+  - `--api-name <name>` to specify the initial API to run. Defaults to `default`
+  - `--params <params json>` to specify the parameters to the initial API.
+  - `--sample-config-str '{<api name>: <sample size>, ...}` to specify the sample config. Only used with `--mode sample`.
+  - `--no-headless` to disable headless mode.
+
+### `intuned project deploy`
+
+- Deploys a project and starts a default job.
+- Options:
+  - `--workspace-info '{"environment_url": <>, "workspace_id": <>, "api_key": <>}'` to specify the workspace info.
+  - `--workspace-info-path` to specify the path to a JSON file containing workspace info.
+  - `-y/--yes` to skip confirmation.
+  - `--project-name` to specify the project name. Resolves the name if not provided.
+- Resolves `.gitignore` from current/parent directories to decide what to deploy.
+- Resolves `.env` from current/parent directories to get environment variables to deploy.
+- Resolves project name from the current/parent directory name if not provided.
+
+### `intuned project serve`
+
+- Serves the project as an HTTP server.
+- Options:
+  - `--env development/production` to specify the environment to run the server.
+    - Development runs using Flask's development server.
+    - Production runs using Waitress.
+  - `--debug` to run the development server in debug mode. Not supported in production.
+- This is used on deployed apps.

intuned_runtime-1.0.0/cli/__init__.py

@@ -0,0 +1,45 @@
+import sys
+import traceback
+
+import arguably
+from dotenv import find_dotenv
+from dotenv import load_dotenv
+from more_termcolor import bold  # type: ignore
+from more_termcolor import red  # type: ignore
+
+from runtime.context.context import IntunedContext
+
+from . import commands
+
+
+def run():
+    dotenv = find_dotenv(usecwd=True)
+    if dotenv:
+        load_dotenv(dotenv, override=True)
+    try:
+        with IntunedContext():
+            arguably.run()
+    except ValueError as e:
+        print(bold(red(str(e))))
+        sys.exit(1)
+    except KeyboardInterrupt:
+        print(bold(red("\n🛑 Aborted")))
+        sys.exit(1)
+    except Exception as e:
+        tb_list = traceback.extract_tb(e.__traceback__)
+
+        DEPTH_THRESHOLD = 4
+
+        if len(tb_list) > DEPTH_THRESHOLD:
+            relevant_frames = tb_list[DEPTH_THRESHOLD:]  # Show last 2 frames - adjust as needed
+            formatted_tb = "".join(traceback.format_list(relevant_frames))
+            print(f"Traceback (most recent call last):\n{formatted_tb}{type(e).__name__}: {str(e)}")
+        else:
+            # For shallow traces, show everything
+            print("".join(traceback.format_exception(type(e), e, e.__traceback__)))
+
+        print(red(bold(f"❌ An error occurred: {e}")))
+        sys.exit(1)
+
+
+__all__ = ["commands", "run"]

intuned_runtime-1.0.0/cli/commands/__init__.py

@@ -0,0 +1,25 @@
+from .ai_source import ai_source  # type: ignore
+from .ai_source import ai_source__deploy  # type: ignore
+from .browser import browser__save_state  # type: ignore
+from .init import init  # type: ignore
+from .project import project  # type: ignore
+from .project import project__run  # type: ignore
+from .project import project__type_check  # type: ignore
+from .project.auth_session import project__auth_session__check  # type: ignore
+from .project.auth_session import project__auth_session__create  # type: ignore
+from .project.auth_session import project__auth_session__load  # type: ignore
+from .publish_packages import publish_packages  # type: ignore
+
+__all__ = [
+    "project__run",
+    "publish_packages",
+    "init",
+    "project",
+    "ai_source__deploy",
+    "ai_source",
+    "project__auth_session__load",
+    "project__auth_session__create",
+    "project__auth_session__check",
+    "project__type_check",
+    "browser__save_state",
+]

intuned_runtime-1.0.0/cli/commands/ai_source/__init__.py

@@ -0,0 +1,4 @@
+from .ai_source import ai_source  # type: ignore
+from .deploy import ai_source__deploy  # type: ignore
+
+__all__ = ["ai_source", "ai_source__deploy"]

intuned_runtime-1.0.0/cli/commands/ai_source/ai_source.py

@@ -0,0 +1,10 @@
+import arguably
+
+
+@arguably.command  # type: ignore
+def ai_source():
+    """
+    Commands to run on AI source projects.
+    """
+
+    pass

intuned_runtime-1.0.0/cli/commands/ai_source/deploy.py

@@ -0,0 +1,64 @@
+import json
+
+import arguably
+from more_termcolor import bold  # type: ignore
+from more_termcolor import cyan  # type: ignore
+from more_termcolor import green  # type: ignore
+from more_termcolor import red  # type: ignore
+
+from cli.utils.code_tree import convert_project_to_code_tree
+
+from ...utils.ai_source_project import AiSourceInfo
+from ...utils.ai_source_project import deploy_ai_source
+
+
+@arguably.command  # type: ignore
+def ai_source__deploy(
+    *,
+    ai_source_info_str: str,
+    ai_source_info_path: str,
+    yes_to_all: bool = False,
+):
+    """
+    Commands to run on AI source projects.
+
+    Args:
+        ai_source_info_str (str): [--ai-source-info] JSON string containing the AI source project information.
+        ai_source_info_path (str): Path to the JSON file containing the AI source project information. Defaults to <current directory>/ai_source.json.
+        yes_to_all (bool): [-y/--yes] Skip confirmation prompts.
+    """
+
+    if ai_source_info_str and ai_source_info_path:
+        raise ValueError("Only one of ai_source_info or ai_source_info_path should be provided.")
+
+    if not (ai_source_info_str or ai_source_info_path):
+        ai_source_info_path = "ai_source.json"
+
+    try:
+        if ai_source_info_str:
+            ai_source_info_json = json.loads(ai_source_info_str)
+        else:
+            with open(ai_source_info_path) as f:
+                ai_source_info_json = json.load(f)
+        ai_source_info = AiSourceInfo(**ai_source_info_json)
+    except json.JSONDecodeError as e:
+        raise ValueError(f"Invalid JSON in ai_source_info: {e}") from e
+    except FileNotFoundError as e:
+        raise ValueError("AI source info file not found") from e
+    except OSError as e:
+        raise ValueError("Error reading AI source info file") from e
+    except TypeError as e:
+        raise ValueError("AI source info is invalid:", str(e)) from e
+
+    wait_for_confirm = not yes_to_all
+
+    code_tree = convert_project_to_code_tree(".", wait_for_confirm=wait_for_confirm)
+
+    success = deploy_ai_source(code_tree, ai_source_info)
+
+    if success:
+        print(
+            f"🚀 AI source deployment triggered for {bold(green(ai_source_info.id))} ({bold(green(ai_source_info.version_id))}). Check progress at {cyan(f"{ai_source_info.environment_url}/__internal-ai-sources/{ai_source_info.id}?version_id={ai_source_info.version_id}")}"
+        )
+    else:
+        print(red(bold("Deployment failed")))

intuned_runtime-1.0.0/cli/commands/browser/__init__.py

@@ -0,0 +1,3 @@
+from .save_state import browser__save_state  # type: ignore
+
+__all__ = ["browser__save_state"]

intuned_runtime-1.0.0/cli/commands/browser/save_state.py

@@ -0,0 +1,32 @@
+import json
+import os
+
+import arguably
+
+from runtime.browser import launch_chromium
+from runtime.browser.storage_state import get_storage_state
+
+
+@arguably.command  # type: ignore
+async def browser__save_state(
+    *,
+    cdp_address: str,
+    output_path: str,
+):
+    """
+    Load an auth session to a browser.
+
+    Args:
+        cdp_address (str): The CDP address of the browser to save the state from.
+        output_path (str): Path to save browser state to.
+    """
+
+    async with launch_chromium(
+        cdp_address=cdp_address,
+    ) as (context, _):
+        storage_state = await get_storage_state(context)
+
+        path = os.path.join(os.getcwd(), output_path)
+        os.makedirs(os.path.dirname(path), exist_ok=True)
+        with open(path, "w") as f:
+            json.dump(storage_state.model_dump(by_alias=True), f, indent=2)

intuned_runtime-1.0.0/cli/commands/init.py

@@ -0,0 +1,127 @@
+import json
+import os
+from typing import Any
+
+import arguably
+import toml
+from more_termcolor import bold  # type: ignore
+from more_termcolor import green  # type: ignore
+
+from ..utils.code_tree import get_project_name
+
+
+@arguably.command  # type: ignore
+def init(
+    *,
+    yes_to_all: bool = False,
+    no_to_all: bool = False,
+    project_name: str | None,
+):
+    """
+    Initializes current app, creating pyproject.toml and Intuned.json files. Will ask for confirmation before overwriting existing files.
+
+    Args:
+        yes_to_all (bool): [-y/--yes] Answer yes to all confirmation prompts
+        no_to_all (bool): [-n/--no] Answer no to any confirmation prompts
+        project_name (str | None): Name of the project. Will automatically resolve if not provided.
+
+    Returns:
+        None
+    """
+
+    if yes_to_all and no_to_all:
+        raise ValueError("Cannot specify both --yes and --no")
+
+    def should_write_file(file: str) -> bool:
+        if not os.path.exists(file):
+            return True
+        if no_to_all:
+            return False
+        elif yes_to_all:
+            print(bold(f"Overwriting {green(file)}"))
+            return True
+        return input(f"Overwrite {green(file)}? (y/N) ").lower().strip() == "y"
+
+    project_name = project_name or get_project_name(".")
+    print(bold("Initializing"), green(project_name))
+
+    def print_created(file: str) -> None:
+        print(bold("📦 Created"), green(file))
+
+    pyproject_name = "pyproject.toml"
+    if should_write_file(pyproject_name):
+        with open(pyproject_name, "w") as f:
+            toml.dump(_get_pyproject(project_name), f)
+        print_created(pyproject_name)
+
+    intuned_json_name = "Intuned.json"
+    if should_write_file(intuned_json_name):
+        with open(intuned_json_name, "w") as f:
+            json.dump(_get_intuned_json(project_name), f, indent=2)
+        print_created(intuned_json_name)
+
+    readme_name = "README.md"
+    if should_write_file(readme_name):
+        with open(readme_name, "w") as f:
+            f.write(_get_readme(project_name))
+        print_created(readme_name)
+
+    print(bold("✨ Done!"))
+
+
+def _get_pyproject(project_name: str) -> dict[str, Any]:
+    return {
+        "build-system": {"requires": ["poetry-core>=1.2.0"], "build-backend": "poetry.core.masonry.api"},
+        "tool": {
+            "poetry": {
+                "package-mode": False,
+                "name": project_name,
+                "version": "0.0.1",
+                "description": f"Project {project_name}",
+                "authors": ["Intuned <service@intunedhq.com>"],
+                "readme": "README.md",
+                "dependencies": {
+                    "python": ">=3.12,<3.13",
+                    "intuned-runtime": {
+                        "git": "ssh://git@github.com/Intuned/python-packages.git",
+                        "tag": "runtime-latest",
+                        "subdirectory": "runtime",
+                    },
+                    "intuned-sdk": {
+                        "git": "ssh://git@github.com/Intuned/python-packages.git",
+                        "tag": "sdk-latest",
+                        "subdirectory": "sdk",
+                    },
+                },
+            }
+        },
+    }
+
+
+def _get_intuned_json(_project_name: str) -> dict[str, Any]:
+    return {
+        "authSessions": {"enabled": False},
+        "scale": {"machineCount": 1, "softLimit": 1, "hardLimit": 5, "memory": 2048, "cpus": 6},
+        "proxy": {"enabled": False},
+    }
+
+
+def _get_readme(project_name: str) -> str:
+    return (
+        f"# `{project_name}` Intuned Automation Project\n"
+        f"\n"
+        f"\n"
+        f"## Getting started\n"
+        f"- Install dependencies: `poetry install`\n"
+        f"- Activate virtual environment: `poetry shell`\n"
+        f"- Project commands: `intuned project --help`\n"
+        f"  - Run the project:\n"
+        f"    - Sample mode: `intuned project run`\n"
+        f"    - Full mode: `intuned project run --mode full`\n"
+        f"    - Single mode: `intuned project run --mode single`\n"
+        f"  - Deploy the project: `intuned project deploy`\n"
+        f"  - Use `--help` for full details on each command.\n"
+        f"\n"
+        f"## SDK\n"
+        f"- If you want to use a specific version of the SDK, make sure to change the tag from `sdk-latest` to `sdk-<version>` in **pyproject.toml**.\n"
+    )

intuned_runtime-1.0.0/cli/commands/project/__init__.py

@@ -0,0 +1,20 @@
+from .auth_session import project__auth_session__check  # type: ignore
+from .auth_session import project__auth_session__create  # type: ignore
+from .auth_session import project__auth_session__load  # type: ignore
+from .project import project  # type: ignore
+from .run import project__run  # type: ignore
+from .run_interface import project__run_interface  # type: ignore
+from .type_check import project__type_check  # type: ignore
+from .upgrade import project__upgrade  # type: ignore
+
+__all__ = [
+    "run",
+    "project__run",
+    "project__type_check",
+    "project",
+    "project__auth_session__load",
+    "project__auth_session__create",
+    "project__auth_session__check",
+    "project__upgrade",
+    "project__run_interface",
+]

intuned_runtime-1.0.0/cli/commands/project/auth_session/__init__.py

@@ -0,0 +1,5 @@
+from .check import project__auth_session__check  # type: ignore
+from .create import project__auth_session__create  # type: ignore
+from .load import project__auth_session__load  # type: ignore
+
+__all__ = ["project__auth_session__check", "project__auth_session__create", "project__auth_session__load"]