Skip to content

Commit 99c27f3

Browse files
Merge pull request #57 from noahsprent/build_package_from_source_instructions
Add instructions to install package from source
2 parents 69311d0 + 088058c commit 99c27f3

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

developer-guide/07-Plugins/03-plugin-as-python-package.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,15 @@ include <PLUGIN_NAME>/LEADER_ONLY
340340

341341
For an example, see the [logs2slack](https://github.com/Pioreactor/pioreactor-logs2slack) plugin's repository.
342342

343+
## Install package from source
344+
345+
It isn't enough to just `pip install` your package, as this will only add the script to the pioreactor system, not any extra configs you may have added.
346+
If you want to install the whole package from source you can simply run:
347+
348+
```
349+
pio plugins install <PLUGIN_NAME> --source <PLUGIN_FOLDER>
350+
```
351+
343352
## Create a Python package on PyPI
344353

345354
Create an account on [https://pypi.org/](https://pypi.org/). Make sure to verify your email.

0 commit comments

Comments
 (0)