Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#1435 - recommend installing jira[cli] to get jirashell deps #1709

Merged
merged 1 commit into from
Sep 28, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@ Installation

The easiest (and best) way to install jira-python is through `pip <https://pip.pypa.io/>`_::

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 <https://virtualenv.pypa.io/>`_:

Expand Down