Skip to content

Commit 14e379a

Browse files
marc-lehnermarc-lehner
committed
AP-24299: added and refined content from basic.zip in the ap documentation
AP-24299 (Document environment specification with pixi for extension developers)
1 parent 60640f8 commit 14e379a

File tree

9 files changed

+385
-0
lines changed

9 files changed

+385
-0
lines changed

‎.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,10 @@ Thumbs.db
4848
*.mov
4949
*.wmv
5050

51+
# pixi environments
52+
.pixi
53+
pixi.lock
54+
*.egg-info
55+
56+
# Local update site (generated by the build process, pixi run build)
57+
local-update-site

‎LICENSE.TXT

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# ![Image](https://www.knime.com/sites/default/files/knime_logo_github_40x40_4layers.png) KNIME® - KNIME PYTHON EXTENSION TEMPLATE
2+
3+
This repository is maintained by the [KNIME Team Rakete](mailto:[email protected]).
4+
5+
It provides a template for creating KNIME Python extensions.
6+
7+
## Contents
8+
9+
This repository contains a template KNIME Python Extensions.
10+
The code is organized as follows:
11+
12+
```
13+
.
14+
├── icons
15+
│ │── icon.png
16+
├── src
17+
│ └── extension.py
18+
├── demos
19+
│ └── Example_with_Python_node.knwf
20+
├── knime.yml
21+
├── pixi.toml
22+
├── config.yml
23+
│── LICENSE.TXT
24+
└── README.md
25+
```
26+
27+
## Instructions
28+
29+
You can find instructions on how to work with our code or develop python extensions for KNIME Analytics Platform in the KNIME documentation:
30+
* [KNIME Python Extension](https://docs.knime.com/latest/pure_python_node_extensions_guide/index.html)
31+
32+
## Minimal Instructions to create a KNIME Python extension
33+
### Prerequisites:
34+
* [KNIME Analytics Platform](https://www.knime.com/downloads/overview)
35+
* [git](https://git-scm.com/downloads)
36+
* [pixi](https://pixi.sh/latest/)
37+
38+
### Instructions:
39+
1. **Clone** this repository or use it as a **template** (click on the green "Use this template" button):
40+
2. **Edit** `knime.yml` - provide your metadata, license, ...
41+
3. _(Optional)_ Modify the `src/extension.py` file to implement your own logic.
42+
4. _(Optional)_ Add python packages to the environment with the following command, or by manually editing the `pixi.toml` file:
43+
```bash
44+
pixi add <package_name>
45+
```
46+
5. **Install** the python environment:
47+
```bash
48+
pixi install
49+
```
50+
6. **Test** the extension in the KNIME Analytics Platform with the extension in debug mode by adding the following line to the knime.ini file (adjust <path_to_this_repository> in the config.yml):
51+
```
52+
-Dknime.python.extension.config=<path/to/your/config.yml>
53+
```
54+
This will start the KNIME Analytics Platform with your extension installed. You can now test your extension in the KNIME Analytics Platform (e.g. demo workflow).
55+
7. **Bundle** your extension:
56+
```bash
57+
pixi run build
58+
```
59+
or if you want the extension's local update site in a specific location (default is `./local_update_site`):
60+
```bash
61+
pixi run build dest=<path_to_your_update_site>
62+
```
63+
8. **Install** the update site in KNIME via
64+
```bash
65+
File > Install KNIME Extensions... > Available Software Sites > Add...
66+
```
67+
and enter the path to your update site (by default `./local_update_site`). After that, you can install your extension.
68+
9. To **publish** on KNIME Hub, follow the [KNIME Hub documentation](https://docs.knime.com/latest/knime_hub_guide/index.html#publishing_your_extension).
69+
70+
For detailed instructions on how to create a KNIME Python extension, please refer to the [KNIME Python Extension documentation](https://docs.knime.com/latest/pure_python_node_extensions_guide/index.html).
71+
72+
## Join the Community
73+
74+
* [KNIME Forum](https://forum.knime.com)

‎config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
org.tutorial.first_extension: # {group_id}.{name} from the knime.yml
2+
src: <path_to_this_repository> # Path to folder containing the extension files
3+
conda_env_path: <path_to_this_repository>/.pixi/envs/default # Path to the Python environment to use (use an absolute path)
4+
debug_mode: true # Optional line, if set to true, it will always use the latest changes of execute/configure, when that method is used within the KNIME Analytics Platform

‎demo/Example_with_Python_node.knwf

6.94 KB
Binary file not shown.

‎icons/icon.png

373 Bytes
Loading

‎knime.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# This is the configuration file for your KNIME extension.
2+
# It is used to define the extension's metadata and configuration.
3+
4+
# Extension metadata
5+
name: first_extension # Will be concatenated with the group_id to an ID
6+
group_id: org.tutorial
7+
description: My First Extension # Human readable bundle name / description
8+
long_description: This extension is my first Python extension.
9+
version: 0.1.0 # Version of this Python node extension
10+
11+
# legal information
12+
author: Bobby Test
13+
vendor: KNIME AG, Zurich, Switzerland
14+
license_file: LICENSE.TXT # Best practice: put your LICENSE.TXT next to the knime.yml; otherwise you would need to change to path/to/LICENSE.txt
15+
16+
17+
# Python settings
18+
pixi_toml_path: pixi.toml # This is necessary for bundling, but not needed during development
19+
extension_module: ./src/extension # The .py Python module containing the nodes of your extension

‎pixi.toml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[workspace]
2+
channels = ["knime/label/nightly", "knime", "conda-forge"]
3+
platforms = ["win-64", "linux-64", "osx-64", "osx-arm64"]
4+
5+
[tasks]
6+
7+
[dependencies]
8+
python = "3.11.*"
9+
knime-extension = "*"
10+
knime-python-base = "*"
11+
12+
[feature.build.dependencies]
13+
python = "3.9.*"
14+
knime-extension-bundling = "5.5.*"
15+
16+
[feature.build.tasks]
17+
build = { args = [{ "arg" = "dest", "default" = "./local-update-site" }], cmd = "python ./.pixi/envs/build/bin/build_python_extension.py . {{ dest }}"}
18+
19+
[environments]
20+
build = {features = ["build"], no-default-feature = true}
21+

0 commit comments

Comments
 (0)