From 65bcd72da93df31735361e2e14c22a0fbe646cd2 Mon Sep 17 00:00:00 2001 From: Jose Caballero Bejar Date: Mon, 6 Jan 2025 13:38:20 +0000 Subject: [PATCH] Document how to install the library Add to the documentation how to install the library and a link to the documentation to get the cloud.yaml file with credentials --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 3bef34b..9981175 100644 --- a/README.md +++ b/README.md @@ -59,3 +59,27 @@ It will address the following issues: # Installation +## Download and install the project +To install it, follow these instructions + + neo@matrix ~ $ git clone https://github.com/stfc/openstack-query-library.git + neo@matrix ~ $ cd openstack-query-library + neo@matrix ~ $ python3 -m pip install . + +To verify the installation was done successfully: + + neo@matrix ~ $ python3 -m pip list | grep openstackquery + openstackquery 0.1.4 + +## Get credentials +In order to use the library, you will need your Cloud credentials on your computer. +Documentation can be found [here](https://stfc.atlassian.net/wiki/spaces/CLOUDKB/pages/211583200/Python+SDK#Setting-Up-Clouds.yaml) + + + + + + + + +