Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to install the library #11

Merged
merged 1 commit into from
Jan 6, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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)









Loading