kaas-cli

Name	kaas-cli JSON
Version	0.1.109 JSON
	download
home_page	None
Summary	Command line utility for K as a Service
upload_time	2024-10-23 03:54:58
maintainer	None
docs_url	None
author	Runtime Verification, Inc.
requires_python	<4.0,>=3.10
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # KaaS CLI

## Simple Installation
Our deployments can be found on [Pypi](https://pypi.org/project/kaas-cli/).

### Installation
`pip install --user kaas-cli`
or 
`sudo pip install kaas-cli`

## For Developers

Prerequisites: `python >= 3.10`, `pip >= 20.0.2`, `poetry >= 1.3.2`.

### Installation

To install the package using `pip`, start by building from [Source](https://github.com/runtimeverification/kaas)

```bash
make build
pip install dist/*.whl
```

Configure the CLI by copying the example environment file and setting up the necessary environment variables:

```bash
cp .flaskenv.example .flaskenv
```

Then, edit the `.flaskenv` file to match your settings.

### Environment Variables

Here's an overview of the environment variables:

- **SERVER_URL**: The KaaS server API address for the main interaction within the CLI tool. This is a required field. For local development, use `http://localhost:5000`.
- **DEFAULT_DIRECTORY**: The folder path for artifacts. This is an optional field. You can leave it empty.
- **DEFAULT_VAULT_ID**: Artifacts should be associated with a project ID. This is an optional field. You can leave it empty.
- **DEFAULT_KEY**: If the user is not the owner of the project, they are required to provide a security key. This is an optional field. You can leave it empty.

### Usage

After installing the dependencies with `poetry install`, you can spawn a shell using `poetry shell`, or alternatively, use `make`:

```bash
make shell
kaas-cli hello
kaas-cli --version
```

To verify the installation, run `kaas-cli hello`. If you see the message `Hello World!`, the CLI is set up correctly.

### Documentation

For detailed usage instructions of the `kaas-cli` tool, please refer to the official [documentation](https://docs.runtimeverification.com/kaas/guides/getting-started).


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "kaas-cli",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "Runtime Verification, Inc.",
    "author_email": "contact@runtimeverification.com",
    "download_url": "https://files.pythonhosted.org/packages/0c/d2/47f509bec62adc27e69a9970b48a34959f7233d6e229a6c2480bce14547d/kaas_cli-0.1.109.tar.gz",
    "platform": null,
    "description": "# KaaS CLI\n\n## Simple Installation\nOur deployments can be found on [Pypi](https://pypi.org/project/kaas-cli/).\n\n### Installation\n`pip install --user kaas-cli`\nor \n`sudo pip install kaas-cli`\n\n## For Developers\n\nPrerequisites: `python >= 3.10`, `pip >= 20.0.2`, `poetry >= 1.3.2`.\n\n### Installation\n\nTo install the package using `pip`, start by building from [Source](https://github.com/runtimeverification/kaas)\n\n```bash\nmake build\npip install dist/*.whl\n```\n\nConfigure the CLI by copying the example environment file and setting up the necessary environment variables:\n\n```bash\ncp .flaskenv.example .flaskenv\n```\n\nThen, edit the `.flaskenv` file to match your settings.\n\n### Environment Variables\n\nHere's an overview of the environment variables:\n\n- **SERVER_URL**: The KaaS server API address for the main interaction within the CLI tool. This is a required field. For local development, use `http://localhost:5000`.\n- **DEFAULT_DIRECTORY**: The folder path for artifacts. This is an optional field. You can leave it empty.\n- **DEFAULT_VAULT_ID**: Artifacts should be associated with a project ID. This is an optional field. You can leave it empty.\n- **DEFAULT_KEY**: If the user is not the owner of the project, they are required to provide a security key. This is an optional field. You can leave it empty.\n\n### Usage\n\nAfter installing the dependencies with `poetry install`, you can spawn a shell using `poetry shell`, or alternatively, use `make`:\n\n```bash\nmake shell\nkaas-cli hello\nkaas-cli --version\n```\n\nTo verify the installation, run `kaas-cli hello`. If you see the message `Hello World!`, the CLI is set up correctly.\n\n### Documentation\n\nFor detailed usage instructions of the `kaas-cli` tool, please refer to the official [documentation](https://docs.runtimeverification.com/kaas/guides/getting-started).\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Command line utility for K as a Service",
    "version": "0.1.109",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f38ff7e26ee5cbafea44012fd18145bd472cc852b1cb372fe8dbc74582f220cb",
                "md5": "520072d5d18738fd443f6213582fe7ba",
                "sha256": "bb7d51eddb9a22228ad2e94dc4ea5c0df4957b68164ced6ccf8b2460fdb8f58c"
            },
            "downloads": -1,
            "filename": "kaas_cli-0.1.109-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "520072d5d18738fd443f6213582fe7ba",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 21403,
            "upload_time": "2024-10-23T03:54:57",
            "upload_time_iso_8601": "2024-10-23T03:54:57.243952Z",
            "url": "https://files.pythonhosted.org/packages/f3/8f/f7e26ee5cbafea44012fd18145bd472cc852b1cb372fe8dbc74582f220cb/kaas_cli-0.1.109-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0cd247f509bec62adc27e69a9970b48a34959f7233d6e229a6c2480bce14547d",
                "md5": "1197f5bf362c82874b47542dd0a1536b",
                "sha256": "0baaa5ce118617b72c779dcfc12ee9066d00b9a85f5e155e6d61528d1c2a66aa"
            },
            "downloads": -1,
            "filename": "kaas_cli-0.1.109.tar.gz",
            "has_sig": false,
            "md5_digest": "1197f5bf362c82874b47542dd0a1536b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 19166,
            "upload_time": "2024-10-23T03:54:58",
            "upload_time_iso_8601": "2024-10-23T03:54:58.390647Z",
            "url": "https://files.pythonhosted.org/packages/0c/d2/47f509bec62adc27e69a9970b48a34959f7233d6e229a6c2480bce14547d/kaas_cli-0.1.109.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-23 03:54:58",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "kaas-cli"
}