tox icon indicating copy to clipboard operation
tox copied to clipboard

Expand installation instruction for common linux distros, macos

Open alago1 opened this issue 3 years ago • 2 comments

The instructions for installing tox through linux/macos package managers mention potential name conflicts with other projects but lacks in examples. I also could not find info anywhere else in the docs that expanded upon this.

I looked through the repositories for the most popular linux distro's package managers and homebrew for macos and added a section with the installation commands. Given there's some variation in project's name between tox, python-tox, and python3-tox, I think this section helps to add some clarity to these specific installation instructions.

Contribution checklist:

(also see CONTRIBUTING.rst for details)

  • [X] wrote descriptive pull request text
  • [ ] added/updated test(s)
  • [X] updated/extended the documentation
  • [ ] added relevant issue keyword in message body
  • [X] added news fragment in changelog folder
    • fragment name: <issue number>.<type>.rst for example (588.bugfix.rst)
    • <type> is must be one of bugfix, feature, deprecation, breaking, doc, misc
    • if PR has no issue: consider creating one first or change it to the PR number after creating the PR
    • "sign" fragment with -- by :user:`<your username>`.
    • please, use full sentences with correct case and punctuation, for example:
      Fixed an issue with non-ascii contents in doctest text files -- by :user:`superuser`.
      
    • also see examples
  • [ ] added yourself to CONTRIBUTORS (preserving alphabetical order)

alago1 avatar Sep 07 '22 22:09 alago1

Duplicate of https://github.com/tox-dev/tox/pull/2476#issuecomment-1221596894.

gaborbernat avatar Sep 07 '22 22:09 gaborbernat

Hey @gaborbernat , would you be able to provide some feedback as to why you think this is a duplicate? The linked PR attempted to add instructions related to installing Python whereas this PR aids in installing the tox package itself. Within the existing installation instructions there's commands to install with pip or from a clone but the linux/macos package manager installations lack much detail which is why I though this change made sense.

alago1 avatar Sep 07 '22 22:09 alago1