From 842f0d02b9620f72b12f9f43d44ebef4cca415a9 Mon Sep 17 00:00:00 2001 From: Kohsuke Kawaguchi Date: Wed, 9 Dec 2020 12:40:28 -0800 Subject: [PATCH 1/2] We require Python3 As per https://www.python.org/dev/peps/pep-0394/, as we require Python3, our instruction should be `pip3` to be more portable regardless of the Python version that `pip` resolves to. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9420647b9..9095c6e42 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Installation ```shell -pip install launchable +pip3 install launchable ``` ## Set your API token From 62af199001420c8ffd3d17890a09e8e930615dbb Mon Sep 17 00:00:00 2001 From: Kohsuke Kawaguchi Date: Wed, 9 Dec 2020 17:11:57 -0800 Subject: [PATCH 2/2] Encouraging for user installation Based on interactions with customers and internal conversations, we think this is better because: * The user doesn't need the super user access, for example when a CI user run against a prebaked Docker image * We know exactly where the binary gets installed as per PEP-370, which make trouble-shooting easier for those who are less familiar with Python. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9095c6e42..10ddbc9db 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # Installation ```shell -pip3 install launchable +pip3 install --user launchable ``` +This creates executable `~/.local/bin/launchable` that should be on your `PATH`. See [PEP-370](https://www.python.org/dev/peps/pep-0370/) for further details. + ## Set your API token ```shell