Skip to content

Add instructions to install package from source #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CamDavidsonPilon merged 1 commit into from
Aug 13, 2025
Merged

Add instructions to install package from source #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions developer-guide/07-Plugins/03-plugin-as-python-package.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,15 @@ include <PLUGIN_NAME>/LEADER_ONLY

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

## Install package from source

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.
If you want to install the whole package from source you can simply run:

```
pio plugins install <PLUGIN_NAME> --source <PLUGIN_FOLDER>
Copy link
Member

@CamDavidsonPilon CamDavidsonPilon Aug 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PLUGIN_FOLDER should be the wheel file, no? Does it work when you point it at the folder (I think no)?

Copy link
Contributor Author

@noahsprent noahsprent Aug 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It works when you point it at the folder! That's why I added these instructions. You don't need to build the wheel

Copy link
Member

@CamDavidsonPilon CamDavidsonPilon Aug 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay! lgtm!

```

## Create a Python package on PyPI

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