Skip to content

Commit f33a3c8

Browse files
committed
Changed Readme to document the new 'register_debug_in_knime' functionality.
1 parent df8b599 commit f33a3c8

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,20 +49,21 @@ You can find general instructions on how to work with our code or develop python
4949
1. **Clone** this repository or use it as a **template** (click on the green "Use this template" button).
5050
2. **Edit** `knime.yml` to provide your metadata, license, etc. The last two lines of this file indicate that the extension created with this repository depends on the KNIME Base Chemistry Types & Nodes and the RDKit extensions.
5151
3. **Modify** the `src/extension.py` file or **add** further files to implement your own logic. Note that every py file equivalent to one node needs to be imported in the init.py file.
52-
4. _(Optional)_ Add python packages to the environment with the following command, or by manually editing the `pixi.toml` file:
52+
4. **Install** the python environment:
5353
```bash
54-
pixi add <package_name>
54+
pixi install
5555
```
56-
If you leave the `pixi.toml` file unchanged, the Python environment that you will create in the next step will have the RDKit package installed per default.
57-
5. **Install** the python environment:
56+
This will install the Python environment as defined in the `pixi.toml` file. If you leave this file unchanged, the Python environment that is installed will have the RDKit package installed per default.
57+
5. _(Optional)_ Add python packages to the environment with the following command, or by manually editing the `pixi.toml` file:
5858
```bash
59-
pixi install
59+
pixi add <package_name>
6060
```
61-
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`):
61+
Note that you have to run the `pixi install` command again after manually editing the `pixi.toml` file.
62+
6. **Install** the extension in debug mode in your KNIME Analytics Platformby running the following command:
6263
```
63-
-Dknime.python.extension.config=<path/to/your/config.yml>
64+
pixi run register_debug_in_knime
6465
```
65-
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).
66+
Previously this step required modifying the `config.yml`and `knime.ini` files manually. This improvement will allow you to select your KNINE Analytics Platform installation and append the `-Dknime.python.extension.config=<path/to/your/config.yml>` argument automatically to the according `knime.ini` file. You can now test your extension in the KNIME Analytics Platform (e.g. demo workflow).
6667
7. **Bundle** your extension:
6768
```bash
6869
pixi run build

0 commit comments

Comments
 (0)