From cc9ea9b1f921096252fa032944f237595db7e8ee Mon Sep 17 00:00:00 2001 From: Daniel Perrefort Date: Thu, 11 Dec 2025 12:31:05 -0500 Subject: [PATCH] Updates install instructions to use BHPC registry --- docs/{installation.md => index.md} | 11 ++++++----- mkdocs.yml | 2 +- 2 files changed, 7 insertions(+), 6 deletions(-) rename docs/{installation.md => index.md} (66%) diff --git a/docs/installation.md b/docs/index.md similarity index 66% rename from docs/installation.md rename to docs/index.md index 7c773ee..ef2f6bb 100644 --- a/docs/installation.md +++ b/docs/index.md @@ -1,16 +1,17 @@ -# Install and Setup +# Keystone Python Client The Keystone platform includes an official Python client that simplifies integration with the application's REST API. It handles authentication, request execution, and response parsing, allowing developers to concentrate on application logic rather than API mechanics. -The client is published on PyPI and can be installed in the standard fashion. +The client is published on the BHPC package registry and can be installed in the standard fashion. -```bash -pip install keystone-api-client +```sh +BHPC_REPO="https://dl.cloudsmith.io/public/better-hpc/keystone/python/simple/" +pip install --extra-index-url=$BHPC_REPO keystone-api-client ``` -!!! note "Version Compatibility" +!!! danger "Version Compatibility" The API client version should match the major and minor version of the upstream API server. For example, if the API version is `2.3.x`, the compatible client version is `2.3.y`. diff --git a/mkdocs.yml b/mkdocs.yml index 272c401..7bd3b4c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ site_name: Keystone Python Client nav: - - installation.md + - Introduction: index.md - session.md - requests.md - logging.md