Skip to content

Incorrect install instructions on web page #1108

Open
@GadgetSteve

Description

@GadgetSteve

Before raising any bug be sure that you used the latest release and that it still reproduces with the latest master. No other version is supported.

Describe the bug
Web page as at 29 July 2021 states:

If you’re going to run the client standalone, we strongly recommend using a virtualenv, which pip can also set up for you:

$ pip -E jira_python install jira
$ workon jira_python

This will only work if you already have virtualenvwrapper installed which is not mentioned as a pre-requisite.

To Reproduce
Steps to reproduce the behavior:
On a fresh python installation that does not include virtualenvwrapper

pip -E jira_python install jira  # Results in: no such option: -E
workon jira_python # Results in: 'workon' is not recognized as an internal or external command, operable program or batch file.
  1. Anybody who is using python but has not installed virtualenvwrapper

Expected behavior
Documentation to include pre-requisites or not use them, e.g. use python -mvenv to create the virtual environment.

Version Information
Type of Jira instance: N/A

  • Jira Cloud (Hosted by Atlassian)
  • Jira Server or Data Center (Self-hosted)
    Python Interpreter: >3.5
    jira-python: N/A
    OS: All
    IPython (Optional): N/A
    Other Dependencies:

Additional context
Documentation problem only but can & will cause confusion for newcomer.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions