truefoundry 0.5.7rc1__tar.gz → 0.5.8rc2__tar.gz

truefoundry-0.5.8rc2/.github/workflows/lint-and-test.yml

@@ -0,0 +1,132 @@
+name: Lint and Test TrueFoundry CLI on multiple platforms
+on:
+  pull_request:
+    branches:
+      - "main"
+
+  push:
+    branches:
+      - "main"
+
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python
+        run: uv venv --python ${{ matrix.python-version }} --seed
+
+      - name: Install the project
+        run: uv sync --locked  --all-extras --dev
+
+      - name: Check files with pre-commit
+        run: |
+          uv run pre-commit run --all-files --show-diff-on-failure -v
+
+  mypy:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python
+        run: uv venv --python ${{ matrix.python-version }} --seed
+
+      - name: Install the project
+        run: uv sync --locked  --all-extras --dev
+
+      - name: Run mypy
+        run: |
+          uv run bash run_mypy.sh
+
+  test-cli:
+    strategy:
+      max-parallel: 3
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.10"]
+
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 15
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python
+        run: uv venv --python ${{ matrix.python-version }} --seed
+
+      - name: Install non dev dependencies
+        run: uv sync --locked --no-dev
+
+      - name: Test TrueFoundry CLI invocations
+        run: |
+          uv run tfy --help
+          uv run tfy deploy --help
+          uv run tfy ml --help
+
+  test:
+    strategy:
+      max-parallel: 3
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.8", "3.12"]
+
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 15
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+
+      - name: Set up Python
+        run: uv venv --python ${{ matrix.python-version }} --seed
+
+      # Install libomp for macOS
+      - name: Install libomp on macOS
+        if: runner.os == 'macOS'
+        run: |
+          brew install libomp
+
+      - name: Install the project
+        run: uv sync --locked  --all-extras --dev
+
+      - name: Run tests
+        run: |
+          uv run pytest --durations=0 tests/

truefoundry-0.5.8rc2/.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Publish pip package to PyPI
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Enable dynamic versioning
+        run: uv run enable_dynamic_versioning.py
+
+      - name: Build project
+        run: uv build --python 3.10
+
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          verbose: true
+          user: __token__

truefoundry-0.5.8rc2/.gitignore

@@ -0,0 +1,152 @@
+# 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

truefoundry-0.5.8rc2/.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+    - id: check-docstring-first
+    - id: check-merge-conflict
+    - id: debug-statements
+    - id: detect-private-key
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-ast
+    - id: check-added-large-files
+      args: ['--maxkb=1000']
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.9.6
+  hooks:
+    - id: ruff-format
+      args:
+        - --config=pyproject.toml
+    - id: ruff
+      args:
+        - --config=pyproject.toml
+        - --fix
+    - id: ruff-format
+      args:
+        - --config=pyproject.toml

truefoundry-0.5.8rc2/.pylintrc

@@ -0,0 +1,6 @@
+[MASTER]
+ignore-paths=^truefoundry/ml/autogen/.*$,
+             ^truefoundry/pydantic_v1.py$
+
+[MESSAGES CONTROL]
+  disable=C0114,C0115,C0116,C0301,W0511,W1203,C0415,C0302,W1514,R0913,R0914,R0912,R0904

truefoundry-0.5.8rc2/.tfy-cli-local.env.example

@@ -0,0 +1,9 @@
+TFY_CLI_LOCAL_TENANT_HOST=internal.devtest.truefoundry.tech
+
+# Devtest Remote
+# TFY_CLI_LOCAL_SERVICEFOUNDRY_SERVER_URL=https://internal.devtest.truefoundry.tech/api/svc
+# TFY_CLI_LOCAL_MLFOUNDRY_SERVER_URL=https://internal.devtest.truefoundry.tech/api/ml
+
+# Local
+TFY_CLI_LOCAL_MLFOUNDRY_SERVER_URL=http://localhost:5000/
+TFY_CLI_LOCAL_SERVICEFOUNDRY_SERVER_URL=http://localhost:3000/

truefoundry-0.5.8rc2/DEVELOPMENT.md

@@ -0,0 +1,45 @@
+# Development
+
+## Instructions
+
+Install `uv`
+
+Follow the docs at https://docs.astral.sh/uv/getting-started/installation/
+
+
+```bash
+# git clone
+git clone https://github.com/truefoundry/truefoundry-cli
+cd truefoundry-cli
+
+# Setup the virtual environment
+uv venv --python 3.9  # or any higher python version
+uv sync --locked --all-extras --dev
+
+# install pre-commit file formatting hooks
+uv run pre-commit install --install-hooks
+uv run pre-commit
+
+# run the tests (inside the shell)
+uv run pytest
+```
+
+# Connecting to Local TFY Services
+
+```
+cp .tfy-cli-local.env.example .tfy-cli-local.env
+export TFY_CLI_LOCAL_DEV_MODE=1
+```
+
+You can control which servicefoundry server and mlfoundry server using the `.tfy-cli-local.env` file
+
+## Releasing a New Version
+
+To release a new version of the TrueFoundry CLI as a Python package, create a new tag on the main branch using GitHub Releases. This will trigger a workflow that publishes the pip package. Tags must be in the format `vx.x.x`, for example `v0.1.0`.
+
+
+# truefoundry/ml/autogen Notes
+
+- Some of the APIs on backend are not encapsulating the request in a DTO
+- It stuffs all entities in truefoundry.ml.autogen.client __init__ which might cause namespace conflicts
+- We should have proper MLRepo Entity and some of the methods on Run need to be action oriented

truefoundry-0.5.8rc2/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: truefoundry
+Version: 0.5.8rc2
+Summary: TrueFoundry CLI
+Author-email: TrueFoundry Team <abhishek@truefoundry.com>
+Requires-Python: <3.13,>=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: mako<2.0.0,>=1.1.6
+Requires-Dist: numpy<2.0.0,>=1.23.0; python_version < '3.12'
+Requires-Dist: numpy<2.0.0,>=1.26.0; python_version >= '3.12'
+Requires-Dist: openai<2.0.0,>=1.16.2
+Requires-Dist: packaging<25.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: scipy<2.0.0,>=1.12.0; python_version >= '3.12'
+Requires-Dist: scipy<2.0.0,>=1.5.0; python_version < '3.12'
+Requires-Dist: tqdm<5.0.0,>=4.0.0
+Requires-Dist: typing-extensions>=4.0
+Requires-Dist: urllib3<3,>=1.26.18
+Requires-Dist: yq<4.0.0,>=3.1.0
+Provides-Extra: workflow
+Requires-Dist: flytekit==1.13.13; 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.5.8rc2/enable_dynamic_versioning.py

@@ -0,0 +1,15 @@
+# /// script
+# requires-python = ">=3.10"
+# dependencies = [
+#   "tomlkit>=0.13.2,<1.0.0",
+# ]
+# ///
+
+import tomlkit
+
+with open("pyproject.toml", "r") as f:
+    spec = tomlkit.parse(f.read())
+    spec["project"].pop("version")
+    spec["project"]["dynamic"].append("version")
+with open("pyproject.toml", "w") as f:
+    f.write(tomlkit.dumps(spec))

truefoundry-0.5.8rc2/pyproject.toml

@@ -0,0 +1,178 @@
+[project]
+name = "truefoundry"
+dynamic = ["version"]
+requires-python = ">=3.8.1,<3.13"
+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,<25.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>=13.7.1,<14.0.0",
+  "rich-click>=1.2.1,<2.0.0",
+  "tqdm>=4.0.0,<5.0.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
+  "scipy>=1.5.0,<2.0.0; python_version < '3.12'",
+  "scipy>=1.12.0,<2.0.0; python_version >= '3.12'",
+  "numpy>=1.23.0,<2.0.0; python_version < '3.12'",
+  "numpy>=1.26.0,<2.0.0; python_version >= '3.12'",
+]
+
+[project.optional-dependencies]
+workflow = ["flytekit==1.13.13"]
+
+[project.scripts]
+tfy = "truefoundry.cli.__main__:main"
+truefoundry = "truefoundry.cli.__main__:main"
+
+[dependency-groups]
+dev = [
+  "Pillow>=9.1.1,<11.0.0",
+  "ipykernel>=6.16.0",
+  "ipywidgets>=8.0.0",
+  "ipython>=7.10.0",
+  "langchain>=0.2.0,<0.3.0",
+  "matplotlib>=3.0.0,<4.0.0",
+  "mypy>=1.14.1",
+  "plotly>=5.8.2,<6.0.0",
+  "pandas>=1.0.0,<3.0.0; python_version < '3.10'",
+  "pandas>=1.4.0,<3.0.0; python_version >= '3.10'",
+  "pre-commit>=3.5.0,<4.0.0",
+  "pytest>=8.2.2,<9.0.0",
+  "pytest-env>=1.1.5,<2.0.0",
+  "ruff>=0.9.4",
+  "seaborn>=0.13.0,<0.14.0",
+  "scikit-learn>=1.3.0,<2.0.0",
+  "shap>=0.40.0,<0.45.0; python_version < '3.12'",
+  "shap>=0.45.0; python_version >= '3.12'",
+  "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", "uv-dynamic-versioning>=0.1.0,<1.0.0; python_version >= '3.9'"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "uv-dynamic-versioning"
+
+[tool.ruff]
+target-version = "py38"
+lint.select = [
+  "E",     # pycodestyle errors
+  "W",     # pycodestyle warnings
+  "F",     # pyflakes
+  "C",     # flake8-comprehensions
+  "B",     # flake8-bugbear
+  "Q",     # flake8-quotes
+  "I",
+  "T10",
+  "ASYNC",
+]
+lint.ignore = ["E501"]
+exclude = [
+  ".venv",
+  "venv",
+  "repos",
+  "truefoundry/ml/autogen/**",
+  "truefoundry/deploy/auto_gen/**",
+]
+
+[tool.ruff.format]
+quote-style = "double"
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+"truefoundry/ml/autogen/client/*" = ["B028", "B904", "C901", "C409", "F841"]
+"truefoundry/ml/autogen/client/models/*" = ["F821"]
+"truefoundry/ml/autogen/client/api_client.py" = ["E721"]
+
+[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/auto_gen",
+  "^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",
+]
+
+[tool.uv]
+default-groups = ["dev"]
+
+[tool.uv-dynamic-versioning]
+vcs = "git"
+strict = true

truefoundry-0.5.8rc2/run_mypy.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+set -e
+
+mypy --strict --no-color-output 2>.mypy-errors.txt || true
+echo "Count for all error types"
+
+echo "===================================================================="
+grep -oE '\[([a-z-]+)\]$' .mypy-errors.txt | grep -oE '[a-z-]+' | sort | uniq -c | sort -nr || true
+echo "===================================================================="
+
+echo "Checking for errors that require fixing"
+
+echo "===================================================================="
+if grep -E '\[(call-arg|valid-type)\]$' .mypy-errors.txt; then
+    echo "Found the above errors. Please fix them"
+    echo "===================================================================="
+    exit 1
+else
+    echo "No errors that require fixing"
+    echo "===================================================================="
+fi
+
+rm -rf .mypy-errors.txt