From c323c7cc14b42c03d10f7fb315f293878b93021c Mon Sep 17 00:00:00 2001 From: Jeff Turner Date: Thu, 28 Sep 2023 23:13:13 +1000 Subject: [PATCH] clarify installing jira[cli] to get jirashell deps (#1709) --- docs/installation.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/installation.rst b/docs/installation.rst index e44a8f3b5..723abda01 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -3,9 +3,10 @@ Installation The easiest (and best) way to install jira-python is through `pip `_:: - pip install jira + pip install 'jira[cli]' -This will handle installation of the client itself as well as the requirements. +This will handle installation of the client itself as well as the requirements. The `[cli]` part installs +dependencies for the `jirashell` binary, and may be omitted if you just need the library. If you're going to run the client standalone, we strongly recommend using a `virtualenv `_: