Skip to content

Commit 082885a

Browse files
authored
Merge pull request #1557 from cburgdorf/christoph/docs/clarify-local-plugin-install
Clarify local plugin install
2 parents 5ef07d9 + 97ea731 commit 082885a

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/guides/trinity/writing_plugins.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,4 +332,10 @@ Check out the `official documentation on entry points <https://packaging.python.
332332
for a deeper explanation.
333333

334334
A plugin where the ``setup.py`` file is configured as described can be installed by
335-
``pip install <package-name>``` and immediately becomes available as a plugin in Trinity.
335+
``pip install <package-name>``` and immediately becomes available as a plugin in Trinity.
336+
337+
.. note::
338+
339+
Plugins installed from a local directory (instead of the pypi registry), such as the sample
340+
plugin described in this article, must be installed with the ``-e`` parameter (Example:
341+
``pip install -e ./trinity-external-plugins/examples/peer_count_reporter``)

0 commit comments

Comments
 (0)