crossplane-function-pythonic 0.5.0__py3-none-any.whl → 0.6.1__py3-none-any.whl

{crossplane_function_pythonic-0.5.0.dist-info → crossplane_function_pythonic-0.6.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crossplane-function-pythonic
-Version: 0.5.0
+Version: 0.6.1
 Summary: A Python centric Crossplane Function
 Project-URL: Documentation, https://github.com/crossplane-contrib/function-pythonic#readme
 Project-URL: Issues, https://github.com/crossplane-contrib/function-pythonic/issues
@@ -14,14 +14,15 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Python: <3.15,>=3.12
-Requires-Dist: crossplane-function-sdk-python==0.11.0
+Requires-Dist: grpcio==1.80.0
 Requires-Dist: inflect==7.5.0
 Requires-Dist: kr8s==0.20.15
+Requires-Dist: protobuf==7.35.0
 Requires-Dist: pyyaml==6.0.3
 Provides-Extra: packages
-Requires-Dist: kopf==1.43.0; extra == 'packages'
+Requires-Dist: kopf==1.44.5; extra == 'packages'
 Provides-Extra: pip-install
-Requires-Dist: pip==26.0.1; extra == 'pip-install'
+Requires-Dist: pip==26.1.1; extra == 'pip-install'
 Description-Content-Type: text/markdown
 
 # function-pythonic
@@ -83,7 +84,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.2
+  package: xpkg.crossplane.io/crossplane-contrib/function-pythonic:v0.6.0
 ```
 
 ### Crossplane V1
@@ -95,7 +96,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.2
+  package: xpkg.crossplane.io/crossplane-contrib/function-pythonic:v0.6.0
   runtimeConfigRef:
     name: function-pythonic
 --
@@ -292,6 +293,7 @@ The BaseComposite class provides the following fields for manipulating the Compo
 | self.metadata | Map | The composite observed metadata |
 | self.spec | Map | The composite observed spec |
 | self.status | Map | The composite desired and observed status, read from observed if not in desired |
+| self.output | Map | The step output, only used during Operations |
 | self.conditions | Conditions | The composite desired and observed conditions, read from observed if not in desired |
 | self.results | Results | Returned results applied to the Composite and optionally on the Claim |
 | self.connectionSecret | Map | The name, namespace, and resourceName to use when generating the connection secret in Crossplane v2 |
@@ -306,17 +308,31 @@ The BaseComposite also provides access to the following Crossplane Function leve
 | self.request | Message | Low level direct access to the RunFunctionRequest message |
 | self.response | Message | Low level direct access to the RunFunctionResponse message |
 | self.logger | Logger | Python logger to log messages to the running function stdout |
+| self.capabilities | Capabilities | This Crossplane version's Capabilities |
 | self.parameters | Map | The configured step parameters |
 | self.ttl | Integer | Get or set the response TTL, in seconds |
 | self.credentials | Credentials | The request credentials |
 | self.context | Map | The response context, initialized from the request context |
 | self.environment | Map | The response environment, initialized from the request context environment |
 | self.requireds | Requireds | Request and read additional local Kubernetes resources |
+| self.schemas | Schemas | Request and read CustomResourceDefinition schemas |
 | self.resources | Resources | Define and process composed resources |
 | self.usages| Boolean | Generate Crossplane Usages for resource dependencies, default False |
 | self.autoReady | Boolean | Perform auto ready processing on all composed resources, default True |
 | self.unknownsFatal | Boolean | Terminate the composition if already created resources are assigned unknown values, default False |
 
+### Capabiities
+
+The Capabilities of the Crossplane version calling function-pythonic.
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| bool(Capabilities) | Boolean | Whether or not the Crossplane version supports Capabilities |
+| Capabiities.requireds | Boolean | Functions can return required resources and Crossplane will fetch the required resources |
+| Capabiities.credentials | Boolean | Functions can receive credentials from secrets specified in the Composition |
+| Capabiities.conditions | Boolean | Functions can return status conditions to be applied to the XR and optionally its claim |
+| Capabiities.schemas | Boolean | Functions can request OpenAPI schemas and Crossplane will return them |
+
 ### Composed Resources
 
 Creating and accessing composed resources is performed using the `BaseComposite.resources` field.
@@ -350,7 +366,7 @@ Resource class:
 
 Creating and accessing required resources is performed using the `BaseComposite.requireds` field.
 `BaseComposite.requireds` is a dictionary of the required resources whose key is the required
-resource name. The value returned when getting a required resource from BaseComposite is the
+schema name. The value returned when getting a required resource from BaseComposite is the
 following RequiredResources class:
 
 | Field | Type | Description |
@@ -363,9 +379,6 @@ following RequiredResources class:
 | RequiredResources.matchName | String | The names to match when returning the required resources |
 | RequiredResources.matchLabels | Map | The labels to match when returning the required resources |
 
-The current version of crossplane-sdk-python used by function-pythonic does not support namespace
-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:
 
@@ -382,6 +395,22 @@ Each resource in the list is the following RequiredResource class:
 | RequiredResource.conditions | Map | The required resource conditions |
 | RequiredResource.connection | Map | The required resource connection details |
 
+### Required Schemas
+
+Creating and accessing required schemas is performed using the `BaseComposite.schemas` field.
+`BaseComposite.schemas` is a dictionary of the required schema whose key is the required
+resource name. The value returned when getting a required resource from BaseComposite is the
+following Schema class:
+
+| Field | Type | Description |
+| ----- | ---- | ----------- |
+| Schema(apiVersion,kind) | Schema | Reset the required schema and set the optional parameters |
+| Schema.name | String | The required schema name |
+| Schema.apiVersion | String | The required schema selector apiVersion |
+| Schema.kind | String | The required schema selector kind |
+| Schema.\_\_getitem\_\_ | Map | The required schema openAPIV3Schema |
+| Schema.\_\_getattr\_\_ | Map | The required schema openAPIV3Schema |
+
 ### Conditions
 
 The `BaseComposite.conditions`, `Resource.conditions`, and `RequiredResource.conditions` fields
@@ -500,7 +529,7 @@ $ function-pythonic render --help
 usage: Crossplane Function Pythonic render [-h] [--debug] [--log-name-width WIDTH] [--logger-level LOGGER=LEVEL] [--python-path DIRECTORY]
                                            [--render-unknowns] [--allow-oversize-protos] [--crossplane-v1] [--kube-context CONTEXT]
                                            [--context-files KEY=PATH] [--context-values KEY=VALUE] [--observed-resources PATH]
-                                           [--required-resources PATH] [--secret-store PATH] [--include-full-xr] [--include-connection-xr]
+                                           [--required-resources PATH] [--required-schemas PATH] [--include-full-xr] [--include-connection-xr]
                                            [--include-function-results] [--include-context]
                                            COMPOSITE [COMPOSITION]
 
@@ -532,8 +561,8 @@ options:
                         A YAML file or directory of YAML files specifying the observed state of composed resources.
   --required-resources, -e PATH
                         A YAML file or directory of YAML files specifying required resources to pass to the Function pipeline.
-  --secret-store, -s PATH
-                        A YAML file or directory of YAML files specifying Secrets to use to resolve connections and credentials.
+  --required-schemas, -s PATH
+                        A JSON file or directory of JSON files specifying required schemas to pass to the Function pipeline.
   --include-full-xr, -x
                         Include a direct copy of the input XR's spedc and metadata fields in the rendered output.
   --include-connection-xr
@@ -602,9 +631,15 @@ status:
 Most of the examples contain a `render.sh` command which uses `function-pythonic render` to
 render the example.
 
-## ConfigMap Packages
+## Shared Python Packages
+
+Python packages and modules can be added to the function-pythonic runtime
+by including the python code in any of the following resources: ConfigMap,
+Secret, EnvironmentConfig, or Composition
+
+### ConfigMap Packages
 
-ConfigMap based python packages are enable using the `--packages` and
+ConfigMap based python packages are enable using the `--packages-configmaps` and
 `--packages-namespace` command line options. ConfigMaps with the label
 `function-pythonic.package` will be incorporated in the python path at
 the location configured in the label value. For example, the following
@@ -666,7 +701,7 @@ data:
       composite: example.pythonic.features.FeatureOneComposite
     ...
 ```
-This requires enabling the the packages support using the `--packages` command
+This requires enabling the the packages support using the `--packages-configmaps` command
 line option in the DeploymentRuntimeConfig and configuring the required
 Kubernetes RBAC permissions. For example:
 ```yaml
@@ -675,7 +710,7 @@ kind: Function
 metadata:
   name: function-pythonic
 spec:
-  package: xpkg.upbound.io/crossplane-contrib/function-pythonic:v0.4.2
+  package: xpkg.crossplane.io/crossplane-contrib/function-pythonic:v0.6.0
   runtimeConfigRef:
     name: function-pythonic
 ---
@@ -737,9 +772,71 @@ ClusterRole permissions. The `--packages-namespace` command line option will res
 to only using the supplied namespace. This option can be invoked multiple times.
 The above RBAC permission can then be per namespace RBAC Role permissions.
 
+### Secret Packages
+
 Secrets can also be used in an identical manner as ConfigMaps by enabling the
 `--packages-secrets` command line option. Secrets permissions need to be
-added to the above RBAC configuration.
+added to the above RBAC configuration. Secret based python packages also enable
+provisioning files with binary data.
+
+### EnvironmentConfig Packages
+
+EnvironmentConfig based provisioning enable an entire package and module
+directory structure. Use the `--packages-environmentconfigs` command line option
+and configure the ClusterRole RBAC access.
+```yaml
+apiVersion: apiextensions.crossplane.io/v1beta1
+kind: EnvironmentConfig
+metadata:
+  name: test
+  labels:
+    function-pythonic.package: 'true'
+data:
+  arootpackage:
+    asubpackage:
+      bmodule.py: |
+        def hello(where):
+          return f"Hello, {where}!"
+    amodule.py: |
+      def goodby(where):
+        return f"Goodby, {where}!"
+```
+### Composition Packages
+
+Composition based provisioning works just like EnvironmentConfig where a
+directory structure is created. Use the `--packages-compositions` command line option
+and configure the ClusterRole RBAC access. The main reason to use Composition
+based provision is because Compositions can be included in a Crossplane
+Configuration Package.
+```yaml
+apiVersion: apiextensions.crossplane.io/v1
+kind: Composition
+metadata:
+  labels:
+    function-pythonic.package: 'true'
+  name: test
+spec:
+  compositeTypeRef:
+    apiVersion: code.pythoni.com/v1alpha1
+    kind: Code
+  mode: Pipeline
+  pipeline:
+  - step: render
+    functionRef:
+      name: function-pythonic
+    input:
+      apiVersion: pythonic.fn.crossplane.io/v1alpha1
+      kind: Composite
+      packages:
+        arootpackage:
+          asubpackage:
+            bmodule.py: |
+              def hello(where):
+                return f"Hello, {where}!"
+          amodule.py: |
+            def goodby(where):
+              return f"Goodby, {where}!"
+```
 
 ## Step Parameters
 

crossplane_function_pythonic-0.6.1.dist-info/RECORD

@@ -0,0 +1,22 @@
+crossplane/pythonic/__about__.py,sha256=BmpWZgjXb-VKaTW2Ok13c3aMep0Fd7G8hL8yn1f5Ak0,73
+crossplane/pythonic/__init__.py,sha256=cRk12kc18RLhc9s5dW6sQqZSCEp80fooRO5zxXqc1oA,292
+crossplane/pythonic/__main__.py,sha256=6vYRlYDJtqFgLyiTamnl3htiNOtz8QlDl5WlIP98I8o,31
+crossplane/pythonic/auto_ready.py,sha256=sPetUuJRhwZbg9muaDmbdqmtTIIUDmY4qoadoJA0EtQ,7201
+crossplane/pythonic/command.py,sha256=aT58WBrhU_scaOGeqmsBfofIDnXyW1CQOpCktVGBj5s,4211
+crossplane/pythonic/composite.py,sha256=jEMXPy9PchOLZxWDGq5ni6lq3g9guItU5hMZi98ZO34,34440
+crossplane/pythonic/function.py,sha256=sea1BJ9_lOPlhYyD8tO9PV6ieeRb-iQOeez07pG2vZk,18535
+crossplane/pythonic/grpc.py,sha256=F3BrfjISGRS2TKeoxUjWeA1LopBaFlZ6nCq_Hei4Di8,5681
+crossplane/pythonic/main.py,sha256=ujUa_FYElQSGqnhZ-0NJrD3kSyYjfRbIp79FV2Yl7hs,599
+crossplane/pythonic/packages.py,sha256=cOlF-wo2CzknwFPAfuwgCiwdT5vDE4n7oBMfQErVzbA,7023
+crossplane/pythonic/protobuf.py,sha256=1Yj8Cgku0w0UYU3dOh6QIaE8HFtkdkhL9b5UERzwAQ0,53978
+crossplane/pythonic/render.py,sha256=lz65rwcg3EvzdWMTUMMA6PvSHqMVTTkrEK11lLe-0XY,33804
+crossplane/pythonic/version.py,sha256=-RiB0p146ayqJj0SXfYxTNv49u9Fx9pPgm59Ji2blhc,214
+crossplane/pythonic/proto/v1/run_function.proto,sha256=GbJ0wVUEjfpMsn2DsnhiPvtmL09z3oyMbWwf6viQtiw,16676
+crossplane/pythonic/proto/v1/run_function_pb2.py,sha256=adoDilRP8JNSsNWtvLQv8egrlnmpnZk8qbo3REMR8EY,14440
+crossplane/pythonic/proto/v1/run_function_pb2.pyi,sha256=MvjcY39d1xJ4ZZmRibhehCKF1mHVGb6qfpoCQO8XYqE,14374
+crossplane/pythonic/proto/v1/run_function_pb2_grpc.py,sha256=mwfE6i_TQHEfh-KemCT10fKA6jlyZ1A0Ih1z6nELkXk,3968
+crossplane_function_pythonic-0.6.1.dist-info/METADATA,sha256=4RBD7g6NimpRSnPQ_qj54B7-k4uk8iSH5Xc7EzHOFfQ,36686
+crossplane_function_pythonic-0.6.1.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+crossplane_function_pythonic-0.6.1.dist-info/entry_points.txt,sha256=jJ4baywFDviB9WyAhyhNYF2VOCb6XtbRSjKf7bnBwhg,68
+crossplane_function_pythonic-0.6.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+crossplane_function_pythonic-0.6.1.dist-info/RECORD,,

crossplane_function_pythonic-0.5.0.dist-info/RECORD

@@ -1,18 +0,0 @@
-crossplane/pythonic/__about__.py,sha256=S3lIpABQ5LwPMuO5TLfDrT_eJOQtFzsph4TXcfnx4OY,73
-crossplane/pythonic/__init__.py,sha256=cRk12kc18RLhc9s5dW6sQqZSCEp80fooRO5zxXqc1oA,292
-crossplane/pythonic/__main__.py,sha256=6vYRlYDJtqFgLyiTamnl3htiNOtz8QlDl5WlIP98I8o,31
-crossplane/pythonic/auto_ready.py,sha256=sPetUuJRhwZbg9muaDmbdqmtTIIUDmY4qoadoJA0EtQ,7201
-crossplane/pythonic/command.py,sha256=aT58WBrhU_scaOGeqmsBfofIDnXyW1CQOpCktVGBj5s,4211
-crossplane/pythonic/composite.py,sha256=niq-JSVZ8NB53Q7khkMqH9vQTJPb6yB-13O-wa2Is1U,30311
-crossplane/pythonic/function.py,sha256=CL2j_Br0eYWbn_8r8md9O9ErfHizz78H1KR8l2oV1IA,17964
-crossplane/pythonic/grpc.py,sha256=9ZQceboDju37NB6AhcUSWpBx_hZQ5W7uo7CZF6ynhfI,4451
-crossplane/pythonic/main.py,sha256=ujUa_FYElQSGqnhZ-0NJrD3kSyYjfRbIp79FV2Yl7hs,599
-crossplane/pythonic/packages.py,sha256=4TxyT6V79R0m4tJbC8R1gwU_vgHGLXKSBzeTTKd8xGo,5120
-crossplane/pythonic/protobuf.py,sha256=nmVf-Xn_-ER8BEfEbqd8uQo2gdhmNYyQh9QlhcaYebs,53083
-crossplane/pythonic/render.py,sha256=Y1-fdjQxvPBSkGjfJnNwCOOg6I-bX7Ys9X4jXkqIZp4,30140
-crossplane/pythonic/version.py,sha256=-RiB0p146ayqJj0SXfYxTNv49u9Fx9pPgm59Ji2blhc,214
-crossplane_function_pythonic-0.5.0.dist-info/METADATA,sha256=yMVu_bg-pjIrhuHDjeTAmKEa082V2pq5NroKIeo9poI,33133
-crossplane_function_pythonic-0.5.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
-crossplane_function_pythonic-0.5.0.dist-info/entry_points.txt,sha256=jJ4baywFDviB9WyAhyhNYF2VOCb6XtbRSjKf7bnBwhg,68
-crossplane_function_pythonic-0.5.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-crossplane_function_pythonic-0.5.0.dist-info/RECORD,,