Feature/cft 3479 run from git

.github/workflows/push.yml

@@ -11,8 +11,8 @@ on:
 concurrency: ci-${{ github.ref }} # to avoid tag collisions in the ECR
 env:
   # repository variables:
-  KBC_DEVELOPERPORTAL_APP: "kds-team.app-custom-python" # replace with your component id
-  KBC_DEVELOPERPORTAL_VENDOR: "kds-team" # replace with your vendor
+  KBC_DEVELOPERPORTAL_APP: "kds-team.app-custom-python"
+  KBC_DEVELOPERPORTAL_VENDOR: "kds-team"
   DOCKERHUB_USER: ${{ secrets.DOCKERHUB_USER }}
   KBC_DEVELOPERPORTAL_USERNAME: "kds-team+github"
 
@@ -230,4 +230,4 @@ jobs:
       - name: Update developer portal properties
         run: |
           chmod +x scripts/developer_portal/*.sh
-          scripts/developer_portal/update_properties.sh
+          scripts/developer_portal/update_properties.sh

.ssh/known_hosts

@@ -0,0 +1,12 @@
+# In case public repositories update their keys, the component will start failing with:
+# Host key verification failed.
+# fatal: Could not read from remote repository.
+#
+# In such case, retrieve the new keys using the following command:
+# ssh-keyscan -t ed25519 github.com
+
+# github.com:22 SSH-2.0-f892a94b
+github.com ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOMqqnkVzrm0SdG6UOoqKLsabgH5C9okWi0dh2l9GKJl
+
+# bitbucket.org:22 SSH-2.0-conker_74c0242eb7-dirty 787a0a0e3e79
+bitbucket.org ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIIazEu89wgQZ4bqs3d63QSMzYVa0MuJ2e2gKTKqu+UUO

Dockerfile

@@ -16,9 +16,25 @@ ENV UV_CACHE_DIR="/.cache/uv"
 # Using the same path as venv defined in the base image so we can use all the preinstalled packages
 ENV UV_PROJECT_ENVIRONMENT="/home/default/"
 
-# Run uv sync as uid/gid 1000 so we don't have to chown the /home/default directory with 100k files =-O
+# Preinstall other Python versions for creating isolated virtual environments
+USER 1000:1000
+RUN uv python install 3.12
+RUN uv python install 3.13
+RUN uv python install 3.14
+
+# Add Github SSH host key to known_hosts file & create .bash_aliases for convenience when debugging
 USER 1000:1000
+RUN mkdir /home/${USERNAME}/.ssh
+COPY .ssh/known_hosts /home/${USERNAME}/.ssh/known_hosts
+RUN echo "alias l='ls -Al --group-directories-first'" >> /home/${USERNAME}/.bash_aliases
 
+# Create root's .ssh directory for storing SSH keys when running sync actions
+USER root
+RUN mkdir /root/.ssh
+COPY .ssh/known_hosts /root/.ssh/known_hosts
+
+# Run uv sync as uid/gid 1000 so we don't have to chown the /home/default directory with 100k files =-O
+USER 1000:1000
 WORKDIR /code/
 COPY pyproject.toml .
 COPY uv.lock .

README.md

@@ -1,15 +1,76 @@
+- [Custom Python Component](#custom-python-component)
+  - [Configuration](#configuration)
+    - [Git configuration](#git-configuration)
+    - [SSH configuration](#ssh-configuration)
+    - [Example: Running code saved in custom repository + template 🧩](#example-running-code-saved-in-custom-repository--template-)
+    - [Example: Listing preinstalled packages](#example-listing-preinstalled-packages)
+    - [Example: Accessing custom configuration parameters](#example-accessing-custom-configuration-parameters)
+  - [Development](#development)
+  - [Integration](#integration)
+
+
 # Custom Python Component
 
 This component lets you run your own Python code directly within Keboola, with support for custom dependencies configured via the UI.
 
 
 ## Configuration
 
-- `code`: JSON encoded Python code to run.
-- `packages`: Array of extra packages to be installed.
+- `source`: Source of the code to run.
+  - `code`: Custom code entered in a text field (default).
+  - `git`: Custom repository.
 - `user_properties`: Object containing custom configuration parameters. The key names prefixed with `#` will be encrypted upon saving.
+- `git`: Object containing configuration of the git repository, which shall be cloned and run (`"source": "git"` only).
+- `code`: JSON encoded Python code to run (`"source": "code"` only).
+- `packages`: Array of extra packages to be installed (`"source": "code"` only). *If you're not sure whether you need to install certain package or not, you can run the command `uv pip list` via subprocess (see the example below).*
+
+
+### Git configuration
+
+The git configuration object supports the following parameters:
+
+- `url`: Repository URL – supports both HTTPS and SSH formats.
+- `branch`: Branch name to checkout – UI provides branch selection.
+- `filename`: Python script filename to execute – UI lists available files.
+- `auth`: Repository visibility & authentication method.
+  - `none`: Public repository, no authentication (default).
+  - `pat`: Private repository, Personal Access Token.
+  - `ssh`: Private repository, SSH key.
+- `#token`: Personal Access Token (`"auth": "pat"` only). This value will be encrypted in Keboola Storage.
+- `ssh_keys`: SSH keys configuration object (`"auth": "ssh"` only).
+
+
+### SSH configuration
+
+- `keys`: Object containing both public and private keys.
+  - `public`: Public key saved in your Git project. This value is not passed by the component and is saved just for future reference.
+  - `#private`: Private key used for authentication. This value will be encrypted in Keboola Storage.
+
+
+### Example: Running code saved in custom repository + template 🧩
+
+As this might become a preferred way of running custom Python code in Keboola for many, we prepared a [simple example project](https://github.com/keboola/component-custom-python-example-repo-1), which help you with your first steps (and can also server you as a template for any of your future projects).
+
+
+Contents of the `config.json` file:
+
+```json
+{
+  "parameters": {
+    "source": "git",
+    "git": {
+      "url": "https://github.com/keboola/component-custom-python-example-repo-1.git",
+      "branch": "main",
+      "filename": "main.py",
+      "auth": "none",
+    },
+    "user_properties": {
+      "debug": true
+    }
+  }
+}
+```
 
-If you're not sure whether you need to install certain package or not, you can run the command `uv pip list` via subprocess (see the example below).
 
 
 ### Example: Listing preinstalled packages
@@ -29,10 +90,10 @@ The above code in the `config.json` file format for local testing:
 
 ```json
 {
-    "parameters": {
-        "code": "import datetime\nimport subprocess\n\nprint(\"Hello world!\")\nprint(\"Current date and time:\", datetime.datetime.now())\nprint(\"See the full list of preinstalled packages:\")\n\nsubprocess.check_call([\"uv\", \"pip\", \"list\"])\n",
-        "packages": []
-    }
+  "parameters": {
+    "code": "import datetime\nimport subprocess\n\nprint(\"Hello world!\")\nprint(\"Current date and time:\", datetime.datetime.now())\nprint(\"See the full list of preinstalled packages:\")\n\nsubprocess.check_call([\"uv\", \"pip\", \"list\"])\n",
+    "packages": []
+  }
 }
 ```
 
@@ -53,14 +114,14 @@ The above code in the `config.json` file format for local testing:
 
 ```json
 {
-    "parameters": {
-        "code": "from keboola.component import CommonInterface\n\nci = CommonInterface()\n# access user parameters\nprint(ci.configuration.parameters)",
-        "packages": [],
-        "user_properties": {
-            "debug": false
-            "#secretCredentials": "theStrongestPasswordEver"
-        }
+  "parameters": {
+    "code": "from keboola.component import CommonInterface\n\nci = CommonInterface()\n# access user parameters\nprint(ci.configuration.parameters)",
+    "packages": [],
+    "user_properties": {
+      "debug": false
+      "#secretCredentials": "theStrongestPasswordEver"
     }
+  }
 }
 ```