Skip to content

Commit 6db9b4d

Browse files
committed
docs(pe): add tabbed examples and warning for installing Python packages
1 parent 8897471 commit 6db9b4d

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

content/shared/v3-core-plugins/_index.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -522,19 +522,45 @@ influxdb3 create trigger \
522522

523523
### Install Python dependencies
524524

525-
If your plugin requires additional Python packages, install them using the CLI:
525+
Use the Processing Engine’s embedded Python environment to install any required third-party packages (for example, `pandas`, `requests`, or `numpy`).
526+
527+
{{% code-placeholders "CONTAINER_NAME|PACKAGE_NAME" %}}
528+
529+
{{< code-tabs-wrapper >}}
530+
531+
{{% code-tabs %}}
532+
[CLI](#)
533+
[Docker](#)
534+
{{% /code-tabs %}}
535+
536+
{{% code-tab-content %}}
526537

527538
```bash
528539
# Install a package directly
529540
influxdb3 install package pandas
530541

531542
```
532543

544+
{{% /code-tab-content %}}
545+
546+
{{% code-tab-content %}}
547+
533548
```bash
534549
# With Docker
535550
docker exec -it CONTAINER_NAME influxdb3 install package pandas
536551
```
537552

553+
{{% /code-tab-content %}}
554+
555+
{{< /code-tabs-wrapper >}}
556+
557+
> [!Note]
558+
> Don’t use `python -m venv` or your system Python to install packages for Processing Engine plugins.
559+
> The Processing Engine includes its own embedded Python environment. Always use the `influxdb3 install package`
560+
> command to ensure packages are installed in the correct environment.
561+
562+
{{% /code-placeholders %}}
563+
538564
This creates a Python virtual environment in your plugins directory with the specified packages installed.
539565

540566
{{% show-in "enterprise" %}}

cypress/downloads/downloads.html

259 KB
Binary file not shown.

0 commit comments

Comments
 (0)