aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Homebrew-and-Python.md
diff options
context:
space:
mode:
authorMike McQuaid2017-01-04 10:53:21 +0000
committerMike McQuaid2017-01-04 10:53:21 +0000
commit127e9def5084063cf33e8acb26a970556ef51148 (patch)
tree7d46e96e7730cd6c00dfa756699ba838931a7854 /docs/Homebrew-and-Python.md
parentfc11f633b29e6a2c9c4d49d5fd5452549b328193 (diff)
downloadbrew-127e9def5084063cf33e8acb26a970556ef51148.tar.bz2
Cleanup documentation site
GitHub now nicely generates a documentation site for us at http://brew.sh/brew based on our docs folder. Optimise the output of this and the GitHub docs directory for readability and the various user groupings.
Diffstat (limited to 'docs/Homebrew-and-Python.md')
-rw-r--r--docs/Homebrew-and-Python.md14
1 files changed, 1 insertions, 13 deletions
diff --git a/docs/Homebrew-and-Python.md b/docs/Homebrew-and-Python.md
index 2500b8592..0757b5d24 100644
--- a/docs/Homebrew-and-Python.md
+++ b/docs/Homebrew-and-Python.md
@@ -1,6 +1,4 @@
-# Homebrew and Python
-## Overview
-
+# Python
This page describes how Python is handled in Homebrew for users. See [Python for Formula Authors](Python-for-Formula-Authors.md) for advice on writing formulae to install packages written in Python.
Homebrew should work with any [CPython](https://stackoverflow.com/questions/2324208/is-there-any-difference-between-cpython-and-python) and defaults to the macOS system Python.
@@ -11,14 +9,12 @@ Homebrew provides formulae to brew a more up-to-date Python 2.7.x (and 3.x).
## Python 2.x or Python 3.x
-
Homebrew provides a formula for Python 2.7.x and one for Python 3.x. They don't conflict, so they can both be installed. The executable `python` will always point to the 2.x and `python3` to the 3.x version.
([Wondering which one to choose?](https://wiki.python.org/moin/Python2orPython3))
## Setuptools, Pip, etc.
-
The Python formulae install [`pip`](http://www.pip-installer.org) and [Setuptools](https://pypi.python.org/pypi/setuptools).
Setuptools can be updated via Pip, without having to re-brew Python:
@@ -30,7 +26,6 @@ Similarly, Pip can be used to upgrade itself via:
pip install --upgrade pip
### Note on `pip install --user`
-
The normal `pip install --user` is disabled for brewed Python. This is because of a bug in distutils, because Homebrew writes a `distutils.cfg` which sets the package `prefix`.
A possible workaround (which puts executable scripts in `~/Library/Python/<X>.<Y>/bin`) is:
@@ -38,7 +33,6 @@ A possible workaround (which puts executable scripts in `~/Library/Python/<X>.<Y
pip install --user --install-option="--prefix=" <package-name>
## `site-packages` and the `PYTHONPATH`
-
The `site-packages` is a directory that contains Python modules (especially bindings installed by other formulae). Homebrew creates it here:
$(brew --prefix)/lib/pythonX.Y/site-packages
@@ -53,11 +47,9 @@ Python 2.7 also searches for modules in:
Homebrew's `site-packages` directory is first created if (1) any Homebrew formula with Python bindings are installed, or (2) upon `brew install python`.
### Why here?
-
The reasoning for this location is to preserve your modules between (minor) upgrades or re-installations of Python. Additionally, Homebrew has a strict policy never to write stuff outside of the `brew --prefix`, so we don't spam your system.
## Homebrew-provided Python bindings
-
Some formulae provide python bindings. Sometimes a `--with-python` or `--with-python3` option has to be passed to `brew install` in order to build the python bindings. (Check with `brew options <formula>`.)
Homebrew builds bindings against the first `python` (and `python-config`) in your `PATH`. (Check with `which python`).
@@ -65,12 +57,10 @@ Homebrew builds bindings against the first `python` (and `python-config`) in you
**Warning!** Python may crash (see [Common Issues](Common-Issues.md)) if you `import <module>` from a brewed Python if you ran `brew install <formula_with_python_bindings>` against the system Python. If you decide to switch to the brewed Python, then reinstall all formulae with python bindings (e.g. `pyside`, `wxwidgets`, `pygtk`, `pygobject`, `opencv`, `vtk` and `boost-python`).
## Policy for non-brewed Python bindings
-
These should be installed via `pip install <x>`. To discover, you can use `pip search` or <https://pypi.python.org/pypi>. (**Note:** System Python does not provide `pip`. Follow the instructions at https://pip.readthedocs.org/en/stable/installing/#install-pip to install it for your system Python if you would like it.)
## Brewed Python modules
-
For brewed Python, modules installed with `pip` or `python setup.py install` will be installed to `$(brew --prefix)/lib/pythonX.Y/site-packages` directory (explained above). Executable python scripts will be in `$(brew --prefix)/bin`.
The system Python may not know which compiler flags to set in order to build bindings for software installed in Homebrew so you may need to:
@@ -79,7 +69,6 @@ The system Python may not know which compiler flags to set in order to build bin
## Virtualenv
-
**WARNING:** When you `brew install` formulae that provide Python bindings, you should **not be in an active virtual environment**.
Activate the virtualenv *after* you've brewed, or brew in a fresh Terminal window.
@@ -88,5 +77,4 @@ Homebrew will still install Python modules into Homebrew's `site-packages` and *
Virtualenv has a switch to allow "global" (i.e. Homebrew's) `site-packages` to be accessible from within the virtualenv.
## Why is Homebrew's Python being installed as a dependency?
-
Formulae that depend on the special :python target are bottled against the Homebrew Python and require it to be installed. You can avoid installing Homebrew's Python by building these formulae with `--build-from-source`.