crossplane-function-pythonic 0.0.7b0__tar.gz → 0.0.8__tar.gz

{crossplane_function_pythonic-0.0.7b0 → crossplane_function_pythonic-0.0.8}/.gitignore

@@ -211,5 +211,6 @@ marimo/_lsp/
 __marimo__/
 
 # function-pythonic
-pythonic-packages/
 crossplane/pythonic/__version__.py
+pocs/
+pythonic-packages/

{crossplane_function_pythonic-0.0.7b0 → crossplane_function_pythonic-0.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crossplane-function-pythonic
-Version: 0.0.7b0
+Version: 0.0.8
 Summary: A Python centric Crossplane Function
 Project-URL: Documentation, https://github.com/fortra/function-pythonic#readme
 Project-URL: Issues, https://github.com/fortra/function-pythonic/issues
@@ -80,7 +80,6 @@ metadata:
 spec:
   package: ghcr.io/fortra/function-pythonic:v0.0.7
 ```
-
 ## Composed Resource Dependencies
 
 function-pythonic automatically handles dependencies between composed resources.
@@ -274,34 +273,46 @@ selection. For now, use matchLabels and filter the results if required.
 RequiredResources acts like a Python list to provide access to the found required resources.
 Each resource in the list is the following RequiredResource class:
 
-| Field | Description |
-| ----- | ----------- |
-| RequiredResource.name | The required resource name |
-| RequiredResource.observed | Low level direct access to the observed required resource |
-| RequiredResource.apiVersion | The required resource apiVersion |
-| RequiredResource.kind | The required resource kind |
-| RequiredResource.metadata | The required resource metadata |
-| RequiredResource.spec | The required resource spec |
-| RequiredResource.data | The required resource data |
-| RequiredResource.status | The required resource status |
-| RequiredResource.conditions | The required resource conditions |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| RequiredResource.name | String | The required resource name |
+| RequiredResource.observed | Map | Low level direct access to the observed required resource |
+| RequiredResource.apiVersion | String | The required resource apiVersion |
+| RequiredResource.kind | String | The required resource kind |
+| RequiredResource.metadata | Map | The required resource metadata |
+| RequiredResource.spec | Map | The required resource spec |
+| RequiredResource.data | Map | The required resource data |
+| RequiredResource.status | Map | The required resource status |
+| RequiredResource.conditions | Map | The required resource conditions |
 
 ### Conditions
 
-The `conditions` field is a map of the resource's status conditions array, with
-the map key being the condition type.
+The `BaseCompsite.conditions`, `Resource.conditions`, and `RequiredResource.conditions` fields
+are maps of that entity's status conditions array, with the map key being the condition type.
+The fields are read only for `Resource.conditions` and `RequiredResource.conditions`.
 
-| Field | Description |
-| ----- | ----------- |
-| Condition.type | The condtion type |
-| Condition.status | RequiredResource.observed | Low level direct access to the observed required resource |
-| RequiredResource.apiVersion | The required resource apiVersion |
-| RequiredResource.kind | The required resource kind |
-| RequiredResource.metadata | The required resource metadata |
-| RequiredResource.spec | The required resource spec |
-| RequiredResource.data | The required resource data |
-| RequiredResource.status | The required resource status |
-| RequiredResource.conditions | The required resource conditions |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| Condition.type | String | The condtion type, or name |
+| Condition.status | Boolean | The condition status |
+| Condition.reason | String | PascalCase, machine-readable reason for this condition |
+| Condition.message | String | Human-readable details about the condition |
+| Condition.lastTransitionTime | Timestamp | Last transition time, read only |
+| Condition.claim | Boolean | Also apply the condition the claim |
+
+### Events
+
+The `BaseComposite.events` field is a list of events to apply to the Composite and
+optionally to the Claim.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| Event.info | Boolean | Normal informational event |
+| Event.warning | Boolean | Warning level event |
+| Event.fatal | Boolean | Fatal events also terminate composing the Composite |
+| Event.reason | String | PascalCase, machine-readable reason for this event |
+| Event.message | String | Human-readable details about the event |
+| Event.claim | Boolean | Also apply the event to the claim |
 
 ## Single use Composites
 
@@ -322,6 +333,85 @@ spec:
         self.status.composite = 'Hello, World!'
 ```
 
+## Quick Start Development
+
+The following example demonstrates how to locally render function-python
+compositions. First, install the `crossplane-function-pythonic` python
+package into the python environment:
+```shell
+$ pip install crossplane-function-pythonic
+```
+Next, create the following files:
+#### xr.yaml
+```yaml
+apiVersion: pythonic.fortra.com/v1alpha1
+kind: Hello
+metadata:
+  name: world
+spec:
+  who: World
+```
+#### composition.yaml
+```yaml
+apiVersion: apiextensions.crossplane.io/v1
+kind: Composition
+metadata:
+  name: hellos.pythonic.fortra.com
+spec:
+  compositeTypeRef:
+    apiVersion: pythonic.fortra.com/v1alpha1
+    kind: Hello
+  mode: Pipeline
+  pipeline:
+  - step: pythonic
+    functionRef:
+      name: function-pythonic
+    input:
+      apiVersion: pythonic.fn.fortra.com/v1alpha1
+      kind: Composite
+      composite: |
+        class Composite(BaseComposite):
+          def compose(self):
+            self.status.greeting = f"Hello, {self.spec.who}!"
+```
+#### functions.yaml
+```yaml
+apiVersion: pkg.crossplane.io/v1beta1
+kind: Function
+metadata:
+  name: function-pythonic
+  annotations:
+    render.crossplane.io/runtime: Development
+spec:
+  package: ghcr.io/fortra/function-pythonic:v0.0.7
+```
+In one terminal session, run function-pythonic:
+```shell
+$ function-pythonic --insecure --debug
+[2025-08-21 15:32:37.966] grpc._cython.cygrpc  [DEBUG   ] Using AsyncIOEngine.POLLER as I/O engine
+```
+In another terminal session, render the Composite:
+```shell
+$ crossplane render xr.yaml composition.yaml functions.yaml
+---
+apiVersion: pythonic.fortra.com/v1alpha1
+kind: Hello
+metadata:
+  name: world
+status:
+  conditions:
+  - lastTransitionTime: "2024-01-01T00:00:00Z"
+    reason: Available
+    status: "True"
+    type: Ready
+  - lastTransitionTime: "2024-01-01T00:00:00Z"
+    message: All resources are composed
+    reason: AllComposed
+    status: "True"
+    type: ResourcesComposed
+  greeting: Hello, World!
+```
+
 ## ConfigMap Packages
 
 ConfigMap based python packages are enable using the `--packages` and

{crossplane_function_pythonic-0.0.7b0 → crossplane_function_pythonic-0.0.8}/README.md

@@ -59,7 +59,6 @@ metadata:
 spec:
   package: ghcr.io/fortra/function-pythonic:v0.0.7
 ```
-
 ## Composed Resource Dependencies
 
 function-pythonic automatically handles dependencies between composed resources.
@@ -253,34 +252,46 @@ selection. For now, use matchLabels and filter the results if required.
 RequiredResources acts like a Python list to provide access to the found required resources.
 Each resource in the list is the following RequiredResource class:
 
-| Field | Description |
-| ----- | ----------- |
-| RequiredResource.name | The required resource name |
-| RequiredResource.observed | Low level direct access to the observed required resource |
-| RequiredResource.apiVersion | The required resource apiVersion |
-| RequiredResource.kind | The required resource kind |
-| RequiredResource.metadata | The required resource metadata |
-| RequiredResource.spec | The required resource spec |
-| RequiredResource.data | The required resource data |
-| RequiredResource.status | The required resource status |
-| RequiredResource.conditions | The required resource conditions |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| RequiredResource.name | String | The required resource name |
+| RequiredResource.observed | Map | Low level direct access to the observed required resource |
+| RequiredResource.apiVersion | String | The required resource apiVersion |
+| RequiredResource.kind | String | The required resource kind |
+| RequiredResource.metadata | Map | The required resource metadata |
+| RequiredResource.spec | Map | The required resource spec |
+| RequiredResource.data | Map | The required resource data |
+| RequiredResource.status | Map | The required resource status |
+| RequiredResource.conditions | Map | The required resource conditions |
 
 ### Conditions
 
-The `conditions` field is a map of the resource's status conditions array, with
-the map key being the condition type.
+The `BaseCompsite.conditions`, `Resource.conditions`, and `RequiredResource.conditions` fields
+are maps of that entity's status conditions array, with the map key being the condition type.
+The fields are read only for `Resource.conditions` and `RequiredResource.conditions`.
 
-| Field | Description |
-| ----- | ----------- |
-| Condition.type | The condtion type |
-| Condition.status | RequiredResource.observed | Low level direct access to the observed required resource |
-| RequiredResource.apiVersion | The required resource apiVersion |
-| RequiredResource.kind | The required resource kind |
-| RequiredResource.metadata | The required resource metadata |
-| RequiredResource.spec | The required resource spec |
-| RequiredResource.data | The required resource data |
-| RequiredResource.status | The required resource status |
-| RequiredResource.conditions | The required resource conditions |
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| Condition.type | String | The condtion type, or name |
+| Condition.status | Boolean | The condition status |
+| Condition.reason | String | PascalCase, machine-readable reason for this condition |
+| Condition.message | String | Human-readable details about the condition |
+| Condition.lastTransitionTime | Timestamp | Last transition time, read only |
+| Condition.claim | Boolean | Also apply the condition the claim |
+
+### Events
+
+The `BaseComposite.events` field is a list of events to apply to the Composite and
+optionally to the Claim.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| Event.info | Boolean | Normal informational event |
+| Event.warning | Boolean | Warning level event |
+| Event.fatal | Boolean | Fatal events also terminate composing the Composite |
+| Event.reason | String | PascalCase, machine-readable reason for this event |
+| Event.message | String | Human-readable details about the event |
+| Event.claim | Boolean | Also apply the event to the claim |
 
 ## Single use Composites
 
@@ -301,6 +312,85 @@ spec:
         self.status.composite = 'Hello, World!'
 ```
 
+## Quick Start Development
+
+The following example demonstrates how to locally render function-python
+compositions. First, install the `crossplane-function-pythonic` python
+package into the python environment:
+```shell
+$ pip install crossplane-function-pythonic
+```
+Next, create the following files:
+#### xr.yaml
+```yaml
+apiVersion: pythonic.fortra.com/v1alpha1
+kind: Hello
+metadata:
+  name: world
+spec:
+  who: World
+```
+#### composition.yaml
+```yaml
+apiVersion: apiextensions.crossplane.io/v1
+kind: Composition
+metadata:
+  name: hellos.pythonic.fortra.com
+spec:
+  compositeTypeRef:
+    apiVersion: pythonic.fortra.com/v1alpha1
+    kind: Hello
+  mode: Pipeline
+  pipeline:
+  - step: pythonic
+    functionRef:
+      name: function-pythonic
+    input:
+      apiVersion: pythonic.fn.fortra.com/v1alpha1
+      kind: Composite
+      composite: |
+        class Composite(BaseComposite):
+          def compose(self):
+            self.status.greeting = f"Hello, {self.spec.who}!"
+```
+#### functions.yaml
+```yaml
+apiVersion: pkg.crossplane.io/v1beta1
+kind: Function
+metadata:
+  name: function-pythonic
+  annotations:
+    render.crossplane.io/runtime: Development
+spec:
+  package: ghcr.io/fortra/function-pythonic:v0.0.7
+```
+In one terminal session, run function-pythonic:
+```shell
+$ function-pythonic --insecure --debug
+[2025-08-21 15:32:37.966] grpc._cython.cygrpc  [DEBUG   ] Using AsyncIOEngine.POLLER as I/O engine
+```
+In another terminal session, render the Composite:
+```shell
+$ crossplane render xr.yaml composition.yaml functions.yaml
+---
+apiVersion: pythonic.fortra.com/v1alpha1
+kind: Hello
+metadata:
+  name: world
+status:
+  conditions:
+  - lastTransitionTime: "2024-01-01T00:00:00Z"
+    reason: Available
+    status: "True"
+    type: Ready
+  - lastTransitionTime: "2024-01-01T00:00:00Z"
+    message: All resources are composed
+    reason: AllComposed
+    status: "True"
+    type: ResourcesComposed
+  greeting: Hello, World!
+```
+
 ## ConfigMap Packages
 
 ConfigMap based python packages are enable using the `--packages` and

{crossplane_function_pythonic-0.0.7b0 → crossplane_function_pythonic-0.0.8}/crossplane/pythonic/main.py

@@ -19,11 +19,7 @@ from . import function
 
 
 def main():
-    try:
-        asyncio.run(Main().main())
-    except:
-        traceback.print_exc()
-        sys.exit(1)
+    asyncio.run(Main().main())
 
 
 class Main:
@@ -38,6 +34,7 @@ class Main:
             '--log-name-width',
             type=int,
             default=40,
+            metavar='WIDTH',
             help='Width of the logger name in the log output, default 40',
         )
         parser.add_argument(
@@ -48,6 +45,7 @@ class Main:
         parser.add_argument(
             '--tls-certs-dir',
             default=os.getenv('TLS_SERVER_CERTS_DIR'),
+            metavar='DIRECTORY',
             help='Serve using mTLS certificates.',
         )
         parser.add_argument(
@@ -69,21 +67,25 @@ class Main:
             '--packages-namespace',
             action='append',
             default=[],
-            help='Namespaces to discover function-pythonic ConfigMaps and Secrets in, default is cluster wide.',
+            metavar='NAMESPACE',
+            help='Namespaces to discover function-pythonic ConfigMaps in, default is cluster wide.',
         )
         parser.add_argument(
             '--packages-dir',
             default='./pythonic-packages',
-            help='Directory to store discovered function-pythonic ConfigMaps and Secrets to, defaults "<cwd>/pythonic-packages"'
+            metavar='DIRECTORY',
+            help='Directory to store discovered function-pythonic ConfigMaps to, defaults "<cwd>/pythonic-packages"'
         )
         parser.add_argument(
             '--pip-install',
+            metavar='COMMAND',
             help='Pip install command to install additional Python packages.'
         )
         parser.add_argument(
             '--python-path',
             action='append',
             default=[],
+            metavar='DIRECTORY',
             help='Filing system directories to add to the python path',
         )
         parser.add_argument(
@@ -92,7 +94,6 @@ class Main:
             help='Allow oversized protobuf messages'
         )
         args = parser.parse_args()
-
         self.configure_logging(args)
 
         if args.pip_install:
@@ -136,11 +137,11 @@ class Main:
             async with asyncio.TaskGroup() as tasks:
                 tasks.create_task(grpc_server.wait_for_termination())
                 tasks.create_task(packages.operator(
+                    grpc_server,
+                    grpc_runner,
                     args.packages_secrets,
                     args.packages_namespace,
                     args.packages_dir,
-                    grpc_server,
-                    grpc_runner,
                 ))
         else:
             def stop():

{crossplane_function_pythonic-0.0.7b0 → crossplane_function_pythonic-0.0.8}/crossplane/pythonic/packages.py

@@ -8,16 +8,15 @@ import sys
 import kopf
 
 
-PACKAGE_LABEL = {'function-pythonic.package': kopf.PRESENT}
-PACKAGES_DIR = None
 GRPC_SERVER = None
 GRPC_RUNNER = None
+PACKAGE_LABEL = {'function-pythonic.package': kopf.PRESENT}
+PACKAGES_DIR = None
 
 
-def operator(packages_secrets, packages_namespace, packages_dir, grpc_server, grpc_runner):
+def operator(grpc_server, grpc_runner, packages_secrets, packages_namespace, packages_dir):
     logging.getLogger('kopf.objects').setLevel(logging.INFO)
-    global PACKAGES_DIR, GRPC_SERVER, GRPC_RUNNER
-    PACKAGES_DIR = packages_dir
+    global GRPC_SERVER, GRPC_RUNNER, PACKAGES_DIR
     GRPC_SERVER = grpc_server
     GRPC_RUNNER = grpc_runner
     PACKAGES_DIR = pathlib.Path(packages_dir).expanduser().resolve()

{crossplane_function_pythonic-0.0.7b0 → crossplane_function_pythonic-0.0.8}/pyproject.toml

@@ -41,6 +41,12 @@ validate-bump = false
 [tool.hatch.build.targets.wheel]
 only-include = ["crossplane"]
 
+[tool.hatch.build.targets.sdist]
+only-include = [
+  "crossplane",
+  "examples",
+]
+
 [tool.hatch.envs.default]
 type = "virtual"
 path = ".venv-default"

crossplane_function_pythonic-0.0.7b0/.coveragerc

@@ -1,2 +0,0 @@
-[run]
-omit = tests/*

crossplane_function_pythonic-0.0.7b0/.devcontainer/devcontainer.json

@@ -1,17 +0,0 @@
-{
-    "name": "function-pythonic-devcontainer",
-    "image": "mcr.microsoft.com/devcontainers/python:3.12-bookworm",
-    "features": {
-        "ghcr.io/devcontainers-extra/features/hatch:2": {},
-        "ghcr.io/devcontainers/features/docker-in-docker:2": {
-            "version": "latest",
-            "enableNonRootDocker": "true",
-            "moby": "false"
-        },
-        "ghcr.io/joebowbeer/devcontainers-features/crossplane:1": {
-            "channel": "stable",
-            "version": "current"
-        }
-    },
-    "postCreateCommand": "hatch env create"
-}