From e3cc56e56bd4771f5aaba40506726552643ac80b Mon Sep 17 00:00:00 2001 From: Dina Graves Portman Date: Wed, 20 Jan 2021 17:03:59 -0800 Subject: [PATCH 1/3] Providing a more direct and helpful pip command Showing how to install the package from this repo using pip3. --- v1alpha1/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/v1alpha1/README.md b/v1alpha1/README.md index 5e65e61..7e270b2 100644 --- a/v1alpha1/README.md +++ b/v1alpha1/README.md @@ -15,12 +15,12 @@ Python 2.7 and 3.4+ ## Installation & Usage ### pip install -If the python package is hosted on Github, you can install directly from Github +To install the package from this repository: ```sh -pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git +pip3 install git+https://github.com/grafeas/client-python.git#egg=swagger_client\&subdirectory=v1alpha1 --user ``` -(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`) +Note: If running on Linux, you need to escape the `&` as shown above. Other systems may not require the escape character. Then import the package: ```python From 75f200601711a10432da0fc46a4e8348ba871202 Mon Sep 17 00:00:00 2001 From: Dina Graves Portman Date: Thu, 21 Jan 2021 09:48:08 -0800 Subject: [PATCH 2/3] Updating pip instruction to reflect new repo structure --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f6bb57a..8993295 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Python 2.7 and 3.4+ To install the package from this repository: ```sh -pip3 install git+https://github.com/grafeas/client-python.git#egg=swagger_client\&subdirectory=v1alpha1 --user +pip3 install git+https://github.com/grafeas/client-python.git#egg=Grafeas --user ``` Note: If running on Linux, you need to escape the `&` as shown above. Other systems may not require the escape character. From 73ba9d2b83b6214fc0c9ead1014ea9f040165d25 Mon Sep 17 00:00:00 2001 From: Dina Graves Portman Date: Wed, 17 Feb 2021 13:50:36 -0800 Subject: [PATCH 3/3] Update README.md Removing the note about escaping the `&` as it is no longer relevant. --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 43919c9..d2e9b6c 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,6 @@ To install the package from this repository: ```sh pip3 install git+https://github.com/grafeas/client-python.git#egg=Grafeas --user ``` -Note: If running on Linux, you need to escape the `&` as shown above. Other systems may not require the escape character. Then import the package: ```python