From 2c77e465495e9495aaaf3739cc7180b2abadbf4b Mon Sep 17 00:00:00 2001 From: Marty Oehme Date: Mon, 9 Jun 2025 13:35:27 +0200 Subject: [PATCH] doc: Add venv tools installation guide --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 16b97ce..e8268cb 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,28 @@ You can install from pypi with `pip install git+https://git.martyoeh.me/Marty/pa That's it! If you have papis and papis-bbt-formatter installed in the same environment (whether virtual or global), everything should now be installed. + +
+Virtual environment setup + +Depending on the way you set up your virtual environments, plugins like this can be _injected_ by the virtual environment manager. + +For example, using `uv`, you can install papis to be accessible globally together with papis-bbt-formatter in the following way: + +```bash +uv tool install --with git+https://git.martyoeh.me/Marty/papis-bbt-formatter.git papis +``` + +Or, with `pipx`: + +```bash +pipx install papis +pipx inject papis git+https://git.martyoeh.me/Marty/papis-bbt-formatter.git +``` + +
+ + ## Usage In your papis configuration file (usually `~/.config/papis/config`), add the following under the main settings header: