From 65991fc51821a676cdc04b1e846dd3c955edb43a Mon Sep 17 00:00:00 2001 From: Arisu Tachibana Date: Wed, 6 Nov 2024 20:01:42 +0900 Subject: [PATCH] README.md: Update with PyPI installation Signed-off-by: Arisu Tachibana --- README.md | 23 ++++++++++------------- docs/index.md | 17 ++++++++++++++++- 2 files changed, 26 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 52aa6dd..040bcb7 100644 --- a/README.md +++ b/README.md @@ -11,27 +11,24 @@ 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 +You can see a example setting file [here](https://raw.githubusercontent.com/kernelci/kci-dev/79e65bc658a56ca0cfcbfa727c1d32916e68a2cd/.kci-dev.toml.example) +```sh +wget https://raw.githubusercontent.com/kernelci/kci-dev/79e65bc658a56ca0cfcbfa727c1d32916e68a2cd/.kci-dev.toml.example +cp .kci-dev.toml.example .kci-dev.toml +``` -The kci-dev project welcomes, and depends on, contribution from developers and users in the open source community. +Remember to add your auth token to the setting file or use it in a limited version (results view only) without a auth token -## 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..c6f1584 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,7 +5,20 @@ 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 +``` + +You can see a example setting file [here](https://raw.githubusercontent.com/kernelci/kci-dev/79e65bc658a56ca0cfcbfa727c1d32916e68a2cd/.kci-dev.toml.example) +```sh +wget https://raw.githubusercontent.com/kernelci/kci-dev/79e65bc658a56ca0cfcbfa727c1d32916e68a2cd/.kci-dev.toml.example +cp .kci-dev.toml.example .kci-dev.toml +``` + +### Using poetry and virtualenv ```sh virtualenv .venv source .venv/bin/activate @@ -14,6 +27,8 @@ poetry install poetry run kci-dev ``` +Remember to add your auth token to the setting file or use it in a limited version (results view only) without a auth token + ## Configuration kci-dev uses a configuration file .kci-dev.toml in the program directory.