Add Readme to document install steps

This commit is contained in:
Casey Faist
2020-03-24 13:16:22 -04:00
parent a1ef075b53
commit b65f0cfce3
+28
View File
@@ -0,0 +1,28 @@
# Python Buildpack Install Steps
TODO: Add context on Python install steps, such as why symlinking vs copying
## Installing the Pip tool
The Python Buildpack uses a tool called `get-pip` to install the pip tool. This
is done in the `python` script.
This is in part because Python historically did not come with pip by default.
## Installing Python packages using Pip
### Convention: Use `python` process to invoke Pip
We don't use this convention (yet) but this is an upcoming change being considered.
This is a bigger concern on Windows than it is in Linux environments, but an
emerging convention in the Python community is to invoke pip using:
```
python3 -m pip [options]
```
Invoking pip this way ensures correct location - python knows where these
packages are stored because it put them there (defaults to Python's pathing info).
All normal command line options are available using this method.