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

Discourage homebrew installation in doc #4444

Merged
merged 3 commits into from
Aug 28, 2020
Merged
Show file tree
Hide file tree
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
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,25 +41,21 @@ You can quickly play with Pipenv right in your browser:
Installation
------------

If you\'re on MacOS, you can install Pipenv easily with Homebrew:

$ brew install pipenv

Or, if you\'re using Debian Buster+:
If you\'re using Debian Buster+:

$ sudo apt install pipenv

Or, if you\'re using Fedora:

$ sudo dnf install pipenv

Or, if you\'re using FreeBSD:

# pkg install py36-pipenv

When none of the above is an option:
When none of the above is an option, it is recommended to use [Pipx](https://pypi.org/p/pipx):

$ pip install pipenv
$ pipx install pipenv

Otherwise, refer to the [documentation](https://pipenv.pypa.io/en/latest/#install-pipenv-today) for instructions.

Expand Down
40 changes: 28 additions & 12 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,22 +80,17 @@ cases.
.. _bundler: http://bundler.io/


Homebrew Installation of Pipenv
---------------------------------
Isolated Installation of Pipenv with Pipx
-------------------------------------------

`Homebrew`_ is a popular open-source package management system for macOS. For Linux users, `Linuxbrew`_ is a Linux port of that.
`Pipx`_ is a tool to help you install and run end-user applications written in Python. It installs applications
into an isolated and clean environment on their own. To install pipx, just run::

Installing pipenv via Homebrew or Linuxbrew will keep pipenv and all of its dependencies in
an isolated virtual environment so it doesn't interfere with the rest of your
Python installation.
$ pip install --user pipx

Once you have installed Homebrew or Linuxbrew simply run::
Once you have ``pipx`` ready on your system, continue to install Pipenv::

$ brew install pipenv

To upgrade pipenv at any time::

$ brew upgrade pipenv
$ pipx install pipenv


☤ Pragmatic Installation of Pipenv
Expand Down Expand Up @@ -149,6 +144,27 @@ If you don't even have pip installed, you can use this crude installation method
$ curl https://raw.githubusercontent.com/pypa/pipenv/master/get-pipenv.py | python


☤ Homebrew Installation of Pipenv(Discouraged)
----------------------------------------------
`Homebrew`_ is a popular open-source package management system for macOS. For Linux users, `Linuxbrew`_ is a Linux port of that.

Installing pipenv via Homebrew or Linuxbrew will keep pipenv and all of its dependencies in
an isolated virtual environment so it doesn't interfere with the rest of your
Python installation.

Once you have installed Homebrew or Linuxbrew simply run::

$ brew install pipenv

To upgrade pipenv at any time::

$ brew upgrade pipenv

.. Note::
Homebrew installation is discouraged because each time the Homebrew Python is upgraded, which Pipenv depends on,
users have to re-install Pipenv, and perhaps all virtual environments managed by it.


☤ Installing packages for your project
======================================

Expand Down
1 change: 1 addition & 0 deletions news/4013.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Discourage homebrew installation in installation guides.