intuned-runtime


Nameintuned-runtime JSON
Version 1.3.6 PyPI version JSON
download
home_pageNone
SummaryRuntime SDK that powers browser automation projects running on Intuned
upload_time2025-10-30 10:42:48
maintainerNone
docs_urlNone
authorIntuned Developers
requires_python<4.0,>=3.9
licenseElastic-2.0
keywords runtime intuned
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "intuned-runtime",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": "runtime, intuned",
    "author": "Intuned Developers",
    "author_email": "engineering@intunedhq.com",
    "download_url": "https://files.pythonhosted.org/packages/8e/1b/e950d6869a671ea8e971ef52df4451b75da6a858cd4ea703e50ec8f5e177/intuned_runtime-1.3.6.tar.gz",
    "platform": null,
    "description": "# Intuned Python Runtime\n\nRuntime commands for Intuned platform Python automations.\n\n## Dependencies\n\n- Requires Python 3.12 or higher.\n- Install poetry: `pip install poetry`\n- Install dependencies: `poetry install`\n- Activate virtual environment: `poetry shell`\n- Now you have access to `intuned` cli from within project.\n\n## Install globally\n\n- This project can be installed globally on the system to use `intuned` cli anywhere\n- Make sure you are not in a virtual environment. `which python` should point to system python.\n  - If you are, `deactivate` to exit virtual environment. Or open in an external terminal (from outside vscode if it doesn't work)\n- Run `pip install -e .` from the root of the project.\n\n## Commands\n\nAll commands have `-h` flag to show help.\n\n### `intuned init`\n\n- Initializes a project. Creates `pyproject.toml`, `Intuned.json` and `README.md` files.\n- Prompts for confirmation for each file that already exists.\n- Options:\n  - `--yes/-y` flag to overwrite all files.\n  - `--no/-n` flag to not overwrite any files.\n\n### `intuned publish-packages`\n\n- Publishes packages to `python-packages` repository.\n- Options:\n  - `--sdk` flag to publish SDK package. Creates `sdk-<version>` and `sdk-latest` tags for the published version.\n  - `--runtime` flag to publish runtime package. Creates `runtime-<version>` and `runtime-latest` tags for the published version.\n  - `--overwrite` flag to overwrite the existing version if it exists.\n  - `--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).\n  - `--no-latest` flag to not release `latest` tag for the published version.\n- Uses the version specified in `pyproject.toml` of each package respectively.\n- Uses WebApp directory specified in `WEBAPP_REPO` environment variable or tries to resolve it (only works if installed globally with `-e` flag).\n- Uses `python-packages` directory to be sister to WebApp directory `<webapp path>/../python-packages`.\n- These packages are used on deployed apps.\n\n### `intuned project run`\n\n- Runs the project.\n  - `--mode` to specify the mode to run. Default is `sample`.\n    - `--mode sample` extends a sample of payloads to run.\n    - `--mode full` runs all extended payloads.\n    - `--mode single` runs the initial API only.\n  - `--api-name <name>` to specify the initial API to run. Defaults to `default`\n  - `--params <params json>` to specify the parameters to the initial API.\n  - `--sample-config-str '{<api name>: <sample size>, ...}` to specify the sample config. Only used with `--mode sample`.\n  - `--no-headless` to disable headless mode.\n\n### `intuned project deploy`\n\n- Deploys a project and starts a default job.\n- Options:\n  - `--workspace-info '{\"environment_url\": <>, \"workspace_id\": <>, \"api_key\": <>}'` to specify the workspace info.\n  - `--workspace-info-path` to specify the path to a JSON file containing workspace info.\n  - `-y/--yes` to skip confirmation.\n  - `--project-name` to specify the project name. Resolves the name if not provided.\n- Resolves `.gitignore` from current/parent directories to decide what to deploy.\n- Resolves `.env` from current/parent directories to get environment variables to deploy.\n- Resolves project name from the current/parent directory name if not provided.\n\n### `intuned project serve`\n\n- Serves the project as an HTTP server.\n- Options:\n  - `--env development/production` to specify the environment to run the server.\n    - Development runs using Flask's development server.\n    - Production runs using Waitress.\n  - `--debug` to run the development server in debug mode. Not supported in production.\n- This is used on deployed apps.\n\n",
    "bugtrack_url": null,
    "license": "Elastic-2.0",
    "summary": "Runtime SDK that powers browser automation projects running on Intuned",
    "version": "1.3.6",
    "project_urls": null,
    "split_keywords": [
        "runtime",
        " intuned"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c4eef2b100afa6a117b97c185c16100e16071010ae822e8ab758d0efc2ad99aa",
                "md5": "219041480fd16f2f725693fc2d154602",
                "sha256": "461d9ce1323a7b98bb5d7a5873d77b6ca9fac6c8f4ba13447b4476eaba908212"
            },
            "downloads": -1,
            "filename": "intuned_runtime-1.3.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "219041480fd16f2f725693fc2d154602",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 105265,
            "upload_time": "2025-10-30T10:42:47",
            "upload_time_iso_8601": "2025-10-30T10:42:47.737996Z",
            "url": "https://files.pythonhosted.org/packages/c4/ee/f2b100afa6a117b97c185c16100e16071010ae822e8ab758d0efc2ad99aa/intuned_runtime-1.3.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8e1be950d6869a671ea8e971ef52df4451b75da6a858cd4ea703e50ec8f5e177",
                "md5": "9c1e51278b0914ea9c81e6596eb9e022",
                "sha256": "f1fb5bbfd4136d6e8f4e408d7f460b6972ac01c05c826e9fa27a119fa2e11871"
            },
            "downloads": -1,
            "filename": "intuned_runtime-1.3.6.tar.gz",
            "has_sig": false,
            "md5_digest": "9c1e51278b0914ea9c81e6596eb9e022",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 61992,
            "upload_time": "2025-10-30T10:42:48",
            "upload_time_iso_8601": "2025-10-30T10:42:48.860056Z",
            "url": "https://files.pythonhosted.org/packages/8e/1b/e950d6869a671ea8e971ef52df4451b75da6a858cd4ea703e50ec8f5e177/intuned_runtime-1.3.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-30 10:42:48",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "intuned-runtime"
}
        
Elapsed time: 0.75462s