Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2026-02-03 14:01:49 +01:00
Code Issues Projects Releases Wiki Activity

Clarify docs for writing plugins

Browse source 
If the beetsplug directory itself is added to the python path
then python does not see the plugin as part of the beetsplug namespace.
This commit is contained in:
Callum Brown 2021-12-19 15:41:31 +00:00
parent 11ad35dcf0
commit fcb73ad095
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/dev/plugins.rst
View file

@ -36,7 +36,8 @@ found therein. Here's a skeleton of a plugin file::
Once you have your ``BeetsPlugin`` subclass, there's a variety of things your
plugin can do. (Read on!)
To use your new plugin, make sure your ``beetsplug`` directory is in the Python
To use your new plugin, make sure the directory that contains your
``beetsplug`` directory is in the Python
path (using ``PYTHONPATH`` or by installing in a `virtualenv`_, for example).
Then, as described above, edit your ``config.yaml`` to include
``plugins: myawesomeplugin`` (substituting the name of the Python module