From e6a78fb7bfc248368580425af90362ea746d3b3b Mon Sep 17 00:00:00 2001 From: Arisu Tachibana Date: Wed, 6 Nov 2024 20:01:42 +0900 Subject: [PATCH 1/2] README.md: Update with PyPI installation Signed-off-by: Arisu Tachibana --- README.md | 20 +++++++------------- docs/index.md | 9 ++++++++- 2 files changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 52aa6dd..20d4105 100644 --- a/README.md +++ b/README.md @@ -11,27 +11,21 @@ kci-dev is a cmdline tool for interact with a enabled KernelCI server ## Quickstart -Using poetry and virtualenv +Using PyPI and virtualenv ```sh virtualenv .venv source .venv/bin/activate -pip install poetry -poetry install -poetry run kci-dev +pip install kci-dev ``` -## Contributing to kci-dev +## Configuration -The kci-dev project welcomes, and depends on, contribution from developers and users in the open source community. +You can see a example configuration file [here](docs/index.md#configuration) +Without a auth token kci-dev can be used in results view only mode -## Contributing guide +## Contributing to kci-dev -Run the following checks before sending a PR -```sh -poetry run black --check --verbose . -poetry run isort . --check --diff -poetry run pytest -rP -``` +The kci-dev project welcomes, and depends on, contribution from developers and users in the open source community. ## License diff --git a/docs/index.md b/docs/index.md index 8c7290a..7ad553a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,7 +5,14 @@ Purpose of this tool to provide a easy way to use features of KernelCI Pipeline ## Installation -Using poetry and virtualenv +### Using PyPI and virtualenv +```sh +virtualenv .venv +source .venv/bin/activate +pip install kci-dev +``` + +### Using poetry and virtualenv ```sh virtualenv .venv source .venv/bin/activate From 1dc963c82a68abdb765ea79fe9c0e9545abb71f6 Mon Sep 17 00:00:00 2001 From: Arisu Tachibana Date: Wed, 6 Nov 2024 21:11:37 +0900 Subject: [PATCH 2/2] docs/index.md: Update .kci-dev.toml informations with pipeline and api Signed-off-by: Arisu Tachibana --- docs/index.md | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/docs/index.md b/docs/index.md index 7ad553a..6a3f238 100644 --- a/docs/index.md +++ b/docs/index.md @@ -28,29 +28,24 @@ kci-dev uses a configuration file .kci-dev.toml in the program directory. default_instance="local" [local] -host="https://127.0.0.1" +pipeline="https://127.0.0.1" +api="https://127.0.0.1:8001/" token="example" -[staging_pipeline] -host="https://staging.kernelci.org:9100/" +[staging] +pipeline="https://staging.kernelci.org:9100/" +api="https://staging.kernelci.org:9000/" token="example" -[staging_api] -host="https://staging.kernelci.org:9000/" -token="example" - -[production_pipeline] -host="https://kernelci-pipeline.westus3.cloudapp.azure.com/" -token="example" - -[production_api] -host="https://kernelci-api.westus3.cloudapp.azure.com/" +[production] +pipeline="https://kernelci-pipeline.westus3.cloudapp.azure.com/" +api="https://kernelci-api.westus3.cloudapp.azure.com/" token="example" ``` Where `default_instance` is the default instance to use, if not provided in the command line. -In section `local`, `staging`, `production` you can provide the host and token for the available instances. -host is the URL of the KernelCI Pipeline API endpoint, and token is the API token to use for authentication. +In section `local`, `staging`, `production` you can provide the host for the pipeline, api and also a token for the available instances. +pipeline is the URL of the KernelCI Pipeline API endpoint, api is the URL of the new KernelCI API endpoint, and token is the API token to use for authentication. If you are using KernelCI Pipeline instance, you can get the token from the project maintainers. If it is a local instance, you can generate your token using [kernelci-pipeline/tools/jwt_generator.py](https://github.com/kernelci/kernelci-pipeline/blob/main/tools/jwt_generator.py) script. @@ -61,7 +56,7 @@ You can provide the instance name to use for the command. Example: ```sh -kci-dev --instance staging_api +kci-dev --instance staging ``` ### settings