Merge branch 'feature/served-pipelines' of https://github.com/zenml-io/zenml into feature/served-pipelines

Author: safoinme

.github/workflows/base-package-functionality.yml

@@ -0,0 +1,78 @@
+---
+name: Test base package functionality
+on:
+  workflow_call:
+    inputs:
+      os:
+        description: OS
+        type: string
+        required: true
+      python-version:
+        description: Python version
+        type: string
+        required: true
+      git-ref:
+        description: Git branch or ref
+        type: string
+        required: false
+        default: ''
+  workflow_dispatch:
+    inputs:
+      os:
+        description: OS
+        type: choice
+        options: [ubuntu-latest, macos-13, windows-latest]
+        required: false
+        default: ubuntu-latest
+      python-version:
+        description: Python version
+        type: choice
+        options: ['3.9', '3.10', '3.11', '3.12']
+        required: false
+        default: '3.11'
+      git-ref:
+        description: Git branch or ref
+        type: string
+        required: true
+jobs:
+  test-base-package-functionality:
+    name: test-base-package-functionality
+    runs-on: ${{ inputs.os }}
+    env:
+      ZENML_DEBUG: 1
+      ZENML_ANALYTICS_OPT_IN: false
+      PYTHONIOENCODING: utf-8
+      UV_HTTP_TIMEOUT: 600
+      OBJC_DISABLE_INITIALIZE_FORK_SAFETY: 'YES'
+    if: ${{ ! startsWith(github.event.head_commit.message, 'GitBook:') && ! (inputs.os == 'windows-latest' && inputs.python-version == '3.11') && ! (inputs.os == 'windows-latest' && inputs.python-version == '3.12') }}
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Checkout code
+        uses: actions/[email protected]
+        with:
+          repository: ${{ github.repository }}
+          ref: ${{ inputs.git-ref || github.event.pull_request.head.sha }}
+      - name: Set up Python
+        uses: actions/[email protected]
+        with:
+          python-version: ${{ inputs.python-version }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: 0.8.14
+      - name: Build server image
+        run: |
+          docker build -t zenml-server-dev -f docker/zenml-server-dev.Dockerfile .
+      - name: Install base package
+        run: |
+          uv pip install --system .
+      - name: Start local server
+        run: |
+          docker run -d -p 8080:8080 -e ZENML_SERVER_AUTH_SCHEME=NO_AUTH -e ZENML_SERVER_AUTO_ACTIVATE=True zenml-server-dev
+      - name: Test server connection works
+        env:
+          ZENML_STORE_URL: http://localhost:8080
+        run: |-
+          zenml stack list

.github/workflows/ci-slow.yml

@@ -316,3 +316,16 @@ jobs:
     needs: run-slow-ci-label-is-set
     uses: ./.github/workflows/vscode-tutorial-pipelines-test.yml
     secrets: inherit
+  ubuntu-base-package-functionality:
+    needs: run-slow-ci-label-is-set
+    if: github.event.pull_request.draft == false
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.11']
+      fail-fast: false
+    uses: ./.github/workflows/base-package-functionality.yml
+    with:
+      python-version: ${{ matrix.python-version }}
+      os: ${{ matrix.os }}
+    secrets: inherit

.github/workflows/linting.yml

@@ -1,5 +1,5 @@
 ---
-name: Setup Python Environment, Lint and Unit Test
+name: Linting
 on:
   workflow_call:
     inputs:
@@ -52,8 +52,8 @@ on:
         required: false
         default: ''
 jobs:
-  unit-test:
-    name: unit-test
+  linting:
+    name: linting
     runs-on: ${{ inputs.os }}
     env:
       ZENML_DEBUG: 1

.github/workflows/publish_to_pypi.yml

@@ -6,6 +6,7 @@ jobs:
   publish_to_pypi:
     name: Publish Python 🐍 package 📦 to PyPI
     runs-on: ubuntu-latest
+    environment: release
     permissions:
       # This permission is required for trusted publishing.
       id-token: write
@@ -23,21 +24,19 @@ jobs:
         uses: actions/[email protected]
         with:
           python-version: '3.9'
-      - name: Install Poetry
-        uses: snok/[email protected]
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
         with:
-          virtualenvs-create: true
-          virtualenvs-in-project: true
+          version: 0.8.14
       - name: Include latest dashboard
         run: bash scripts/install-dashboard.sh
-      - name: Build package
-        run: poetry build
-      - name: Mint token
-        id: mint
-        uses: tschm/[email protected]
-      - name: Publish the package with poetry
+      - name: Verify version
         run: |-
-          if [ "$(cat src/zenml/VERSION)" = "$(echo ${GITHUB_REF} | sed 's|refs/tags/||g')" ];
-          then poetry publish -u __token__ -p '${{ steps.mint.outputs.api-token }}';
-          else echo "Version mismatch between src/zenml/VERSION and branch tag" && exit 1;
+          if [ "$(cat src/zenml/VERSION)" != "$(echo ${GITHUB_REF} | sed 's|refs/tags/||g')" ]; then
+            echo "Version mismatch between src/zenml/VERSION and git tag"
+            exit 1
           fi
+      - name: Build package
+        run: uv build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/update-templates-to-examples.yml

@@ -46,7 +46,7 @@ jobs:
           python-version: ${{ inputs.python-version }}
           stack-name: local
           ref-zenml: ${{ github.ref }}
-          ref-template: 2024.11.28  # Make sure it is aligned with ZENML_PROJECT_TEMPLATES from src/zenml/cli/base.py
+          ref-template: 2025.09.22  # Make sure it is aligned with ZENML_PROJECT_TEMPLATES from src/zenml/cli/base.py
       - name: Clean-up
         run: |
           rm -rf ./local_checkout
@@ -261,7 +261,7 @@ jobs:
         with:
           python-version: ${{ inputs.python-version }}
           ref-zenml: ${{ github.ref }}
-          ref-template: 2025.07.14  # Make sure it is aligned with ZENML_PROJECT_TEMPLATES from src/zenml/cli/base.py
+          ref-template: 2025.09.19  # Make sure it is aligned with ZENML_PROJECT_TEMPLATES from src/zenml/cli/base.py
       - name: Clean-up
         run: |
           rm -rf ./local_checkout

docs/book/getting-started/hello-world.md

@@ -16,7 +16,7 @@ This guide will help you build and deploy your first ZenML pipeline, starting lo
 Start by installing ZenML in a fresh Python environment:
 
 ```bash
-pip install zenml
+pip install 'zenml[server]'
 zenml login
 ```
 
@@ -82,7 +82,7 @@ The fastest way to create a cloud stack is through the **Infrastructure-as-Code*
 
 You'll need:
 
-* [Terraform](https://www.terraform.io/downloads.html) version 1.9+ installed locally
+* [Terraform](https://developer.hashicorp.com/terraform/install) version 1.9+ installed locally
 * Authentication configured for your preferred cloud provider (AWS, GCP, or Azure)
 * Appropriate permissions to create resources in your cloud account
 

docs/book/getting-started/installation.md

@@ -9,51 +9,50 @@ icon: cauldron
 {% step %}
 #### Install ZenML
 
+ZenML currently supports **Python 3.9, 3.10, 3.11, and 3.12**. Please make sure that you are using a supported Python version.
+
 {% tabs %}
-{% tab title="Direct (pip)" %}
-**ZenML** is a Python package that can be installed directly via `pip`:
+{% tab title="Base package" %}
+**ZenML** is a Python package that can be installed using `pip` or other Python package managers:
 
 ```shell
 pip install zenml
 ```
 
 {% hint style="warning" %}
-Note that ZenML currently supports **Python 3.9, 3.10, 3.11, and 3.12**. Please make sure that you are using a supported Python version.
+Installing the base package only allows you to connect to a [deployed ZenML server](./deploying-zenml/). If you want to use ZenML purely locally, install it with the `local` extra:
+```shell
+pip install 'zenml[local]'
+```
 {% endhint %}
 {% endtab %}
 
-{% tab title="Dashboard" %}
-ZenML comes bundled with a web dashboard that lives inside a [sister repository](https://github.com/zenml-io/zenml-dashboard). In order to get access to the dashboard **locally**, you need to launch the [ZenML Server and Dashboard locally](deploying-zenml/). For this, you need to install the optional dependencies for the ZenML Server:
+{% tab title="Local Dashboard" %}
+If you want to use the [ZenML dashboard](https://github.com/zenml-io/zenml-dashboard) locally, you need to install ZenML with the `server` extra: 
 
 ```shell
-pip install "zenml[server]"
+pip install 'zenml[server]'
 ```
 
-{% hint style="info" %}
-We highly encourage you to install ZenML in a virtual environment. At ZenML, we like to use [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/) or [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv) to manage our Python virtual environments.
-{% endhint %}
-{% endtab %}
-
-{% tab title="MacOS Silicon (M1, M2)" %}
-A change in how forking works on Macs running on Apple Silicon means that you\
-should set the following environment variable, which will ensure that your connections to the server remain unbroken:
-
+{% hint style="warning" %}
+If you want to run a local server while running on a Mac with Apple Silicon (M1, M2, M3, M4), you should set the following environment variable:
 ```bash
 export OBJC_DISABLE_INITIALIZE_FORK_SAFETY=YES
-
-pip install zenml
 ```
+You can read more about this [here](http://sealiesoftware.com/blog/archive/2017/6/5/Objective-C_and_fork_in_macOS_1013.html).
+{% endhint %}
 
-You can read more about this [here](http://sealiesoftware.com/blog/archive/2017/6/5/Objective-C_and_fork_in_macOS_1013.html). This environment variable is needed if you are working with a local server on your Mac, but if you're just using ZenML as a client / CLI and connecting to a deployed server, then you don't need to set it.
 {% endtab %}
 
-{% tab title="Nightly Builds" %}
-ZenML also publishes nightly builds under the [`zenml-nightly` package name](https://pypi.org/project/zenml-nightly/). These are built from the latest [`develop` branch](https://github.com/zenml-io/zenml/tree/develop) (to which work ready for release is published) and are not guaranteed to be stable. To install the nightly build, run:
+{% tab title="Jupyter Notebooks" %}
+If you write your ZenML pipelines ins Jupyter notebooks, we recommend installing ZenML with the `jupyter` extra which includes improved CLI output and logs:
 
 ```shell
-pip install zenml-nightly
+pip install 'zenml[jupyter]'
 ```
+
 {% endtab %}
+
 {% endtabs %}
 {% endstep %}
 
@@ -96,11 +95,12 @@ If you would like to run the ZenML server with Docker:
 docker run -it -d -p 8080:8080 zenmldocker/zenml-server
 ```
 
-## Deploying the server
+## Starting the local server
 
-Though ZenML can run entirely as a pip package on a local system, complete with the dashboard. You can do this easily:
+By default, ZenML runs without a server connected to a local database on your machine. If you want to access the dashboard locally, you need to start a local server:
 
 ```shell
+# Make sure to have the `server` extra installed
 pip install "zenml[server]"
 zenml login --local  # opens the dashboard locally 
 ```