Skip to content

Commit

Permalink
Document how to install the library
Browse files Browse the repository at this point in the history
Add to the documentation how to install the library and a link to the
documentation to get the cloud.yaml file with credentials
  • Loading branch information
jose-caballero committed Jan 6, 2025
1 parent ba9d83e commit 65bcd72
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)









0 comments on commit 65bcd72

Please sign in to comment.