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.

Sign up for GitHub

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

Update README.md #43

Merged
merged 2 commits into from
Nov 6, 2024
+26 −30
Merged

Update README.md #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6a78fb
README.md: Update with PyPI installation
aliceinwire Nov 6, 2024
1dc963c
docs/index.md: Update .kci-dev.toml informations with pipeline and api
aliceinwire Nov 6, 2024
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
20 changes: 7 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
36 changes: 19 additions & 17 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -21,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"
token="example"

[staging_pipeline]
host="https://staging.kernelci.org:9100/"
token="example"

[staging_api]
host="https://staging.kernelci.org:9000/"
pipeline="https://127.0.0.1"
api="https://127.0.0.1:8001/"
token="example"

[production_pipeline]
host="https://kernelci-pipeline.westus3.cloudapp.azure.com/"
[staging]
pipeline="https://staging.kernelci.org:9100/"
api="https://staging.kernelci.org:9000/"
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.

Expand All @@ -54,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
Expand Down
Loading