Skip to content

Commit

Permalink
Updating installation instructions (#1551)
Browse files Browse the repository at this point in the history
`pip -E` was removed in pip 1.1 (2012-02-16). https://pip.pypa.io/en/stable/news/#v1-1
  • Loading branch information
denilsonsa committed Nov 16, 2022
1 parent b4a33bc commit b1fbec8
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,20 @@ The easiest (and best) way to install jira-python is through `pip <https://pip.p

This will handle installation of the client itself as well as the requirements.

If you're going to run the client standalone, we strongly recommend using a `virtualenv <https://virtualenv.pypa.io/>`_,
which pip can also set up for you
If you're going to run the client standalone, we strongly recommend using a `virtualenv <https://virtualenv.pypa.io/>`_:

.. code-block:: bash
pip -E jira_python install jira
workon jira_python
python -m venv jira_python
source jira_python/bin/activate
pip install 'jira[cli]'
or:

.. code-block:: bash
python -m venv jira_python
jira_python/bin/pip install 'jira[cli]'
Doing this creates a private Python "installation" that you can freely upgrade, degrade or break without putting
the critical components of your system at risk.
Expand Down

0 comments on commit b1fbec8

Please sign in to comment.