truefoundry 0.13.6__tar.gz

truefoundry-0.13.6/.gitignore

@@ -0,0 +1,156 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+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/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+
+
+# mlflow local files
+mlruns/
+mlf/
+
+# local build files
+servicefoundry/
+tmp/
+
+# dataset files
+*.gz
+aclImdb/
+
+# Jetbrains files
+.idea/
+
+# VSCode files
+.vscode/
+
+# Mac Poop
+**/.DS_Store
+
+.mypy-errors.txt
+
+almond-output*
+rt*.jar
+hsperfdata_*

truefoundry-0.13.6/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: truefoundry
+Version: 0.13.6
+Summary: TrueFoundry CLI
+Author-email: TrueFoundry Team <abhishek@truefoundry.com>
+Requires-Python: <3.15,>=3.8.1
+Requires-Dist: aenum<4.0.0,>=3.0.0
+Requires-Dist: click<9.0.0,>=7.0.0
+Requires-Dist: coolname<2.0.0,>=1.1.0
+Requires-Dist: docker<8.0.0,>=6.1.2
+Requires-Dist: filelock<4.0.0,>=3.8.0
+Requires-Dist: gitignorefile<2.0.0,>=1.1.2
+Requires-Dist: gitpython<4.0.0,>=3.1.43
+Requires-Dist: importlib-metadata<9.0.0,>=4.11.3
+Requires-Dist: importlib-resources<7.0.0,>=5.2.0
+Requires-Dist: jinja2<4.0.0,>=3.1.6
+Requires-Dist: mako<2.0.0,>=1.1.6
+Requires-Dist: numpy<3.0.0,>=1.23.0
+Requires-Dist: openai<2.0.0,>=1.16.2
+Requires-Dist: packaging<26.0,>=20.0
+Requires-Dist: pydantic<3.0.0,>=1.8.2
+Requires-Dist: pygments<3.0.0,>=2.12.0
+Requires-Dist: pyjwt<3.0.0,>=2.0.0
+Requires-Dist: python-dateutil<3.0.0,>=2.8.2
+Requires-Dist: python-dotenv<2.0.0,>=1.0.1
+Requires-Dist: python-socketio[client]<6.0.0,>=5.5.2
+Requires-Dist: pyyaml<7.0.0,>=6.0.0
+Requires-Dist: questionary<2.0.0,>=1.10.0
+Requires-Dist: requests<3.0.0,>=2.18.0
+Requires-Dist: requirements-parser<0.12.0,>=0.11.0
+Requires-Dist: rich-click<2.0.0,>=1.2.1
+Requires-Dist: rich<14.0.0,>=13.7.1
+Requires-Dist: tqdm<5.0.0,>=4.0.0
+Requires-Dist: truefoundry-sdk<0.2.0,>=0.1.16
+Requires-Dist: typing-extensions>=4.0
+Requires-Dist: urllib3<3,>=1.26.18
+Requires-Dist: yq<4.0.0,>=3.1.0
+Provides-Extra: ai
+Requires-Dist: mcp==1.9.4; (python_version >= '3.10') and extra == 'ai'
+Provides-Extra: spark
+Requires-Dist: flytekit==1.15.3; (python_version >= '3.9' and python_version <= '3.12') and extra == 'spark'
+Requires-Dist: flytekitplugins-spark==1.15.3; (python_version >= '3.9' and python_version <= '3.12') and extra == 'spark'
+Provides-Extra: workflow
+Requires-Dist: flytekit==1.15.3; (python_version >= '3.9' and python_version <= '3.12') and extra == 'workflow'
+Description-Content-Type: text/markdown
+
+# TrueFoundry
+
+TrueFoundry library to help you interact with the platform programmatically by
+
+- Interacting with the deployments side of TrueFoundry, enabling you to manage workspaces, deployments, applications, and view logs.
+- Providing experiment tracking capabilities, allowing you to track ML experiments and interact with ML repositories within TrueFoundry.
+
+You can access the health of your service, monitoring links, deployed endpoints and track metadata and artifacts by logging on to TrueFoundry's dashboard.
+
+## Installation
+
+To install the `TrueFoundry CLI`, you can use pip:
+
+```bash
+pip install truefoundry
+```
+
+To install the `TrueFoundry CLI` with Workflow deployment features, you can use pip:
+
+```bash
+pip install truefoundry[workflow]
+```
+
+## Examples
+
+https://github.com/truefoundry/getting-started-examples
+
+## Documentation
+
+https://docs.truefoundry.com/

truefoundry-0.13.6/README.md

@@ -0,0 +1,30 @@
+# TrueFoundry
+
+TrueFoundry library to help you interact with the platform programmatically by
+
+- Interacting with the deployments side of TrueFoundry, enabling you to manage workspaces, deployments, applications, and view logs.
+- Providing experiment tracking capabilities, allowing you to track ML experiments and interact with ML repositories within TrueFoundry.
+
+You can access the health of your service, monitoring links, deployed endpoints and track metadata and artifacts by logging on to TrueFoundry's dashboard.
+
+## Installation
+
+To install the `TrueFoundry CLI`, you can use pip:
+
+```bash
+pip install truefoundry
+```
+
+To install the `TrueFoundry CLI` with Workflow deployment features, you can use pip:
+
+```bash
+pip install truefoundry[workflow]
+```
+
+## Examples
+
+https://github.com/truefoundry/getting-started-examples
+
+## Documentation
+
+https://docs.truefoundry.com/

truefoundry-0.13.6/pyproject.toml

@@ -0,0 +1,194 @@
+[project]
+name = "truefoundry"
+version = "0.13.6"  # This is a placeholder version, it will be replaced when releasing
+requires-python = ">=3.8.1,<3.15"
+description = "TrueFoundry CLI"
+authors = [{ name = "TrueFoundry Team", email = "abhishek@truefoundry.com" }]
+readme = "README.md"
+dependencies = [
+  "aenum>=3.0.0,<4.0.0",
+  "click>=7.0.0,<9.0.0",
+  "coolname>=1.1.0,<2.0.0",
+  "docker>=6.1.2,<8.0.0",
+  "filelock>=3.8.0,<4.0.0",
+  "gitignorefile>=1.1.2,<2.0.0",
+  "GitPython>=3.1.43,<4.0.0",
+  "importlib-metadata>=4.11.3,<9.0.0",
+  "importlib-resources>=5.2.0,<7.0.0",
+  "Mako>=1.1.6,<2.0.0",
+  "openai>=1.16.2,<2.0.0",
+  "packaging>=20.0,<26.0",
+  "pydantic>=1.8.2,<3.0.0",
+  "pygments>=2.12.0,<3.0.0",
+  "PyJWT>=2.0.0,<3.0.0",
+  "python-dateutil>=2.8.2,<3.0.0",
+  "python-dotenv>=1.0.1,<2.0.0",
+  "python-socketio[client]>=5.5.2,<6.0.0",
+  "PyYAML>=6.0.0,<7.0.0",
+  "questionary>=1.10.0,<2.0.0",
+  "requests>=2.18.0,<3.0.0",
+  "requirements-parser>=0.11.0,<0.12.0",
+  "rich-click>=1.2.1,<2.0.0",
+  "rich>=13.7.1,<14.0.0",
+  "tqdm>=4.0.0,<5.0.0",
+  "truefoundry-sdk>=0.1.16,<0.2.0",
+  "typing-extensions>=4.0",
+  "urllib3>=1.26.18,<3",
+  "yq>=3.1.0,<4.0.0",
+  # Check and try to eliminate libs below this comment
+  "numpy>=1.23.0,<3.0.0",
+  "Jinja2>=3.1.6,<4.0.0"
+]
+
+[project.optional-dependencies]
+workflow = [
+  "flytekit==1.15.3; python_version >= '3.9' and python_version <= '3.12'",
+]
+spark = [
+  "flytekit==1.15.3; python_version >= '3.9' and python_version <= '3.12'",
+  "flytekitplugins-spark==1.15.3; python_version >= '3.9' and python_version <= '3.12'",
+]
+ai = [
+  "mcp==1.9.4 ; python_version >= '3.10'",
+]
+
+[project.scripts]
+tfy = "truefoundry.cli.__main__:main"
+truefoundry = "truefoundry.cli.__main__:main"
+
+[dependency-groups]
+dev = [
+  "accelerate>=1.0.0,<2.0.0",
+  "datasets>=3.0.0,<5.0.0",
+  "ipykernel>=6.16.0",
+  "ipython>=7.10.0",
+  "ipywidgets>=8.0.0",
+  "matplotlib>=3.0.0,<4.0.0",
+  "mypy>=1.14.1",
+  "omegaconf==2.3",
+  "pandas>=1.0.0,<3.0.0; python_version < '3.10'",
+  "pandas>=1.4.0,<3.0.0; python_version >= '3.10'",
+  "Pillow>=9.1.1,<11.0.0",
+  "plotly>=5.8.2,<6.0.0",
+  "pre-commit>=3.5.0,<4.0.0",
+  "pytest-env>=1.1.5,<2.0.0",
+  "pytest>=8.2.2,<9.0.0",
+  "ruff>=0.9.4",
+  "scikit-learn>=1.3.0,<2.0.0",
+  "seaborn>=0.13.0,<0.14.0",
+  "transformers>=4.0.0,<5.0.0",
+  "xgboost>=2.1.3,<3.0.0",
+
+  # typing stubs
+  "types-PyYAML",
+  "types-pytz",
+  "types-python-dateutil",
+  "types-protobuf",
+  "types-pexpect",
+  "types-docutils",
+  "types-defusedxml",
+  "types-decorator",
+  "types-colorama",
+  "types-cffi",
+  "types-requests",
+  "types-Pygments",
+  "pandas-stubs",
+  "types-tqdm",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+[tool.hatch.build.targets.sdist]
+include = [
+  "truefoundry/"
+]
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.ruff]
+target-version = "py38"
+exclude = [
+  ".venv",
+  "venv",
+  "repos",
+]
+
+[tool.ruff.lint]
+select = [
+  "E",     # pycodestyle errors
+  "W",     # pycodestyle warnings
+  "F",     # pyflakes
+  "C",     # flake8-comprehensions
+  "B",     # flake8-bugbear
+  "Q",     # flake8-quotes
+  "I",
+  "T10",
+  "ASYNC",
+  "NPY201",
+]
+ignore = ["E501"]
+
+[tool.ruff.lint.flake8-quotes]
+docstring-quotes = "double"
+inline-quotes = "double"
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+"truefoundry/ml/_autogen/client/*" = ["B028", "B904", "C901", "C409", "F841"]
+"truefoundry/ml/_autogen/models/*" = ["E721"]
+"truefoundry/ml/_autogen/client/models/*" = ["F821"]
+"truefoundry/ml/_autogen/client/api_client.py" = ["E721"]
+"truefoundry/deploy/lib/clients/_mcp_streamable_http.py" = ["C901", "ASYNC109"]
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.mypy]
+plugins = ["pydantic.v1.mypy"]
+install_types = true
+non_interactive = true
+
+allow_redefinition = false
+allow_untyped_globals = false
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+follow_imports = "silent"
+force_uppercase_builtins = true
+no_implicit_optional = true
+no_implicit_reexport = true
+strict_equality = true
+strict_optional = true
+warn_no_return = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unreachable = true
+warn_unused_ignores = true
+
+packages = ["truefoundry"]
+exclude = [
+  "^truefoundry/ml/_autogen",
+  "^truefoundry/deploy/_autogen",
+  "^truefoundry/pydantic_v1.py$",
+  "^truefoundry/autodeploy/",
+]
+disable_error_code = ["import-untyped", "method-assign"]
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
+warn_required_dynamic_aliases = true
+
+[tool.pytest.ini_options]
+env = [
+  "TFY_PYTHONBUILD_PYTHON_IMAGE_REPO=docker.io/truefoundrycloud/test/python",
+  "TFY_SPARK_BUILD_SPARK_IMAGE_REPO=public.ecr.aws/bitnami/spark",
+]
+
+[tool.uv]
+default-groups = ["dev"]

truefoundry-0.13.6/truefoundry/__init__.py

@@ -0,0 +1,48 @@
+from truefoundry_sdk import (
+    AssistantMessage,
+    ChatPromptManifest,
+    DeveloperMessage,
+    FunctionSchema,
+    ModelConfiguration,
+    Parameters,
+    PromptVersion,
+    SystemMessage,
+    ToolCall,
+    ToolMessage,
+    ToolSchema,
+    UserMessage,
+)
+from truefoundry_sdk.client import TrueFoundry
+
+from truefoundry._client import client
+from truefoundry.common.warnings import (
+    suppress_truefoundry_deprecation_warnings,
+    suppress_truefoundry_ml_autogen_warnings,
+    surface_truefoundry_deprecation_warnings,
+)
+from truefoundry.deploy.core import login, logout
+from truefoundry.ml.prompt_utils import render_prompt
+
+suppress_truefoundry_ml_autogen_warnings()
+surface_truefoundry_deprecation_warnings()
+
+__all__ = [
+    "AssistantMessage",
+    "ChatPromptManifest",
+    "client",
+    "DeveloperMessage",
+    "FunctionSchema",
+    "login",
+    "logout",
+    "ModelConfiguration",
+    "Parameters",
+    "PromptVersion",
+    "render_prompt",
+    "suppress_truefoundry_deprecation_warnings",
+    "SystemMessage",
+    "TrueFoundry",
+    "ToolCall",
+    "ToolMessage",
+    "ToolSchema",
+    "UserMessage",
+]

truefoundry-0.13.6/truefoundry/_ask/cli.py

@@ -0,0 +1,156 @@
+import asyncio
+import logging
+from typing import Callable, Dict, Optional, Tuple, Union
+
+import rich_click as click
+from openai import AsyncOpenAI
+from rich.console import Console
+
+from truefoundry.cli.config import CliConfig
+from truefoundry.cli.const import COMMAND_CLS
+from truefoundry.cli.util import handle_exception_wrapper, select_cluster
+from truefoundry.common.constants import (
+    ENV_VARS,
+    TFY_ASK_MODEL_NAME_KEY,
+    TFY_ASK_OPENAI_API_KEY_KEY,
+    TFY_ASK_OPENAI_BASE_URL_KEY,
+)
+from truefoundry.common.session import Session
+from truefoundry.common.utils import get_tfy_servers_config
+
+console = Console()
+
+
+class CustomAsyncOpenAI(AsyncOpenAI):
+    def __init__(
+        self, *, api_key: Optional[Union[str, Callable[[], str]]] = None, **kwargs
+    ):
+        self.__api_key_fn = None
+        if isinstance(api_key, str) or api_key is None:
+            _api_key = api_key
+        else:
+            self.__api_key_fn = api_key
+            _api_key = self.__api_key_fn()
+        super().__init__(api_key=_api_key, **kwargs)
+
+    @property
+    def auth_headers(self) -> Dict[str, str]:
+        if self.__api_key_fn is not None:
+            api_key = self.__api_key_fn()
+        else:
+            api_key = self.api_key
+        return {"Authorization": f"Bearer {api_key}"}
+
+
+def _get_openai_client(session: Session) -> Tuple[CustomAsyncOpenAI, str]:
+    """
+    Returns an AsyncOpenAI client using either user-provided credentials or TrueFoundry LLM gateway.
+    """
+    if ENV_VARS.TFY_ASK_OPENAI_BASE_URL:
+        console.print(
+            f"Found custom OpenAI compatible API settings ([green]{TFY_ASK_OPENAI_BASE_URL_KEY}[/green]) in env"
+        )
+        if ENV_VARS.TFY_ASK_OPENAI_API_KEY:
+            console.print(
+                f"Found API key ([green]{TFY_ASK_OPENAI_API_KEY_KEY}[/green]) in env"
+            )
+            api_key = ENV_VARS.TFY_ASK_OPENAI_API_KEY
+        else:
+            console.print(
+                f"No API key found in env, using [yellow]EMPTY[/yellow] as API key"
+                f"\n[dim]Tip: To use a different API key, set the env var "
+                f"[green]{TFY_ASK_OPENAI_API_KEY_KEY}[/green] to the API key you want to use.[/dim]"
+            )
+            api_key = "EMPTY"
+        base_url = ENV_VARS.TFY_ASK_OPENAI_BASE_URL
+        default_model = "gpt-4o"
+    else:
+        tfy_servers_config = get_tfy_servers_config(session.tfy_host)
+        base_url = f"{tfy_servers_config.servicefoundry_server_url}/v1/tfy-ai/proxy/api/inference/openai"
+        console.print(
+            f"Using TrueFoundry Managed AI."
+            f"\n[dim]Tip: To use your own OpenAI API compatible API for the ask command, set the following env vars"
+            f"\n * [green]{TFY_ASK_OPENAI_BASE_URL_KEY}[/] to the base URL of your OpenAI compatible API. E.g. [yellow]https://api.openai.com/v1[/yellow]"
+            f"\n * [green]{TFY_ASK_OPENAI_API_KEY_KEY}[/] to the API key of your OpenAI compatible API."
+            f"[/dim]"
+        )
+        console.print("")
+
+        api_key = lambda: session.access_token  # noqa: E731
+        default_model = "tfy-ai-openai/gpt-4o"
+    client = CustomAsyncOpenAI(
+        base_url=base_url,
+        api_key=api_key,
+    )
+    if ENV_VARS.TFY_ASK_MODEL_NAME:
+        openai_model = ENV_VARS.TFY_ASK_MODEL_NAME
+        console.print(
+            f"Using custom model from env [green]{TFY_ASK_MODEL_NAME_KEY}[/green]: [yellow]{openai_model}[/yellow]"
+        )
+    else:
+        openai_model = default_model
+        console.print(
+            f"Using default model: [yellow]{openai_model}[/yellow]"
+            f"\n[dim]Tip: To use a different model, set the env var "
+            f"[green]{TFY_ASK_MODEL_NAME_KEY}[/green] to the model name you want to use.[/dim]"
+        )
+    console.print("")
+
+    if ENV_VARS.TFY_ASK_OPENAI_BASE_URL:
+        console.print(
+            "[dim][yellow]This operation will use tokens from your model provider and may incur costs.[/yellow][/dim]"
+        )
+        console.print("")
+    return client, openai_model
+
+
+@click.command(name="ask", cls=COMMAND_CLS)
+@click.option(
+    "-c",
+    "--cluster",
+    type=str,
+    required=False,
+    help="The cluster id from TrueFoundry. If not provided, an interactive prompt will list available clusters",
+)
+@click.pass_context
+@handle_exception_wrapper
+def ask_command(ctx, cluster: str) -> None:
+    """
+    Ask questions related to your Cluster in TrueFoundry.
+    """
+    from truefoundry._ask.client import ask_client
+
+    debug = CliConfig.debug
+    if debug:
+        _mcp_logger = logging.getLogger("mcp")
+        _mcp_logger.setLevel(logging.DEBUG)
+        _mcp_logger.addHandler(logging.StreamHandler())
+
+    session = Session.new()
+    console.print(
+        "\n[bold green]Welcome to the Ask Command![/bold green]\n"
+        "Use this command to ask questions and troubleshoot issues in your Kubernetes cluster managed by the TrueFoundry Control Plane.\n"
+        "It helps you investigate and identify potential problems across services, pods, deployments, and more.\n"
+    )
+    openai_client, openai_model = _get_openai_client(session=session)
+    if not cluster:
+        console.print(
+            "[dim]Tip: You can specify a cluster using the '--cluster' option, or select one interactively from the list.[/dim]\n"
+        )
+    cluster = select_cluster(cluster)
+    tfy_servers_config = get_tfy_servers_config(session.tfy_host)
+    mcp_server_url = f"{tfy_servers_config.servicefoundry_server_url}/v1/k8s-mcp"
+    asyncio.run(
+        ask_client(
+            cluster=cluster,
+            server_url=mcp_server_url,
+            token=session.access_token,
+            openai_client=openai_client,
+            openai_model=openai_model,
+            debug=debug,
+        )
+    )
+
+
+def get_ask_command():
+    return ask_command