fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-07-04 07:26:14 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

[Test] run behave tests with test plugins outside project root

Browse source
This commit is contained in:
MinchinWeb 2021-05-16 21:14:21 -06:00
parent 3492dd291a
commit 9888d98860
3 changed files with 19 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/plugins.md
View file

@ -165,10 +165,17 @@ situations other than a traditional export. They are:
## Development Tips
- editable installs (`pip install -e ...`) don't seem to play nice with
- Editable installs (`pip install -e ...`) don't seem to play nice with
the namespace layout. If your plugin isn't appearing, try a non-editable
install of both *jrnl* and your plugin.
- If you run *jrnl* from the main project root directory (the one that contains
*jrnl*'s source code), namespace plugins won't be recognized. This is (I
suspect) because the Python interpreter will find your *jrnl* source directory
(which doesn't contain your namespace plugins) before it find your
"site-packages" directory (i.e. installed packages, which will recognize
namespace packages).
- Don't name your plugin file "testing.py" or it won't be installed (at least
automatically) by pip.
- For examples, you can look to the *jrnl*'s internal importers and exporters.
As well, there are some basic external examples included in *jrnl*'s git repo
at `tests/external_plugins_src` (including the example code above).