From b65f0cfce36cb1b77c81b3e5b8cd833c28f67a52 Mon Sep 17 00:00:00 2001 From: Casey Faist Date: Tue, 24 Mar 2020 13:16:22 -0400 Subject: [PATCH] Add Readme to document install steps --- bin/steps/README.MD | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 bin/steps/README.MD diff --git a/bin/steps/README.MD b/bin/steps/README.MD new file mode 100644 index 0000000..3c23cf7 --- /dev/null +++ b/bin/steps/README.MD @@ -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.