Plugin development setup issue

[gunstr]

I want to add plugin development capabilities to my devcontainer setup. I have followed the documentation including installing the plugin into the venv with pip install -e /workspaces/inventree-plugin.

Where I fail is how to get the develoment server to recognize the plugin. I would assume that just because the plugin is in the venv it will not be recognized. Should it also be added to the /dev/plugins.txt file and if so - what is the syntax?

[SchrodingersGat]

@gunstr that should be perfectly fine - this is how I run all my plugin development.

1. Create a plugin (ideally use the inventree plugin creator tool)
2. pip install -e
3. Restart the dev server (so that the plugin discovery works)
4. Activate the plugin in the admin interface

It does not need to be added to the plugins file. This file is for automatically installing plugins from a remote source (e.g. pypi)

[SchrodingersGat]

As there are many packages in the venv I would assume there is someting specific that the plugin discovery looks for?

Yes, there is a very specific format required - within the pyproject.toml file.

If you are building a plugin from scratch it can be hard. I'd suggest that you scaffold it using the plugin creator tool, and build the functionality on top of that

[gunstr]

OK, I will start over again. A very basic question regarding the devcontainer - with the productions system running on Bare Metal I use the log files a lot when someting goes wrong. I was looking for the same now in the devcontainer but I cannot find them - where are the logs saved?

[SchrodingersGat]

If you are running the server from the command line then the logs will simply be in the shell output:

e.g.

invoke dev.server

will stream the access logs:

[gunstr]

That I have seen, but there is very few lines being logged during boot - maybe that is just because of differences in the loglevel setting...

[gunstr]

Success - I started over again and created an empty plugin with the creator and that one is discovered. I must have messed up someting when I merged scaffold with the "old" plugin.

[gunstr]

@SchrodingersGat I have now merged the plugin scaffold generated by the Creator with my "old" handcrafted plugin and it runs well in the devcontainer.

But I have one problem left where I do not find a solution. - I can't get breakpoints to work in the plugin. I use the ValidationMixin for some custom validation on IPNs using the validate_part_ipn function. I can set a breakpoint in the part model in the core code just before the call to validate_part_ipn and single step into the plugin code but the debugger never stops at the breakpoint within the plugin. The breakpoint is recogized in the debugger list like this:

Have you seen something like this and have an idea what might causing it?

[SchrodingersGat]

You are probably not using the "debug with 3rd party support" option in vscode.

The default debug option only looks at code within the core InvenTree code base.

[gunstr]

I do launch with "debug with 3rd party support" and the "justMyCode": true is recogized, else the single stepping into the plugin code would not work either if I remember correctly.

I'm using a setup with WSL 2 on windows and have the source code installed in the WSL 2 file system. I read a lot comments about issues with file system performance with WSL 2, maybe it's better to spin up a full Linux VM for the InvenTree development?

[SchrodingersGat]

I can set a breakpoint in the part model in the core code just before the call to validate_part_ipn and single step into the plugin code but the debugger never stops at the breakpoint within the plugin.

I missed this line in your previous comment. So, I'm not sure why you can break there but not in the breakpoint position...