kdcube-cli 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. kdcube_cli-0.1.0/LICENSE +21 -0
  2. kdcube_cli-0.1.0/PKG-INFO +133 -0
  3. kdcube_cli-0.1.0/README.md +101 -0
  4. kdcube_cli-0.1.0/pyproject.toml +21 -0
  5. kdcube_cli-0.1.0/setup.cfg +4 -0
  6. kdcube_cli-0.1.0/src/kdcube_cli/__init__.py +1 -0
  7. kdcube_cli-0.1.0/src/kdcube_cli/assets/pixel-cubes.png +0 -0
  8. kdcube_cli-0.1.0/src/kdcube_cli/assets/pixel-cubes.svg +386 -0
  9. kdcube_cli-0.1.0/src/kdcube_cli/banner.py +388 -0
  10. kdcube_cli-0.1.0/src/kdcube_cli/cli.py +120 -0
  11. kdcube_cli-0.1.0/src/kdcube_cli.egg-info/PKG-INFO +133 -0
  12. kdcube_cli-0.1.0/src/kdcube_cli.egg-info/SOURCES.txt +14 -0
  13. kdcube_cli-0.1.0/src/kdcube_cli.egg-info/dependency_links.txt +1 -0
  14. kdcube_cli-0.1.0/src/kdcube_cli.egg-info/entry_points.txt +2 -0
  15. kdcube_cli-0.1.0/src/kdcube_cli.egg-info/requires.txt +1 -0
  16. kdcube_cli-0.1.0/src/kdcube_cli.egg-info/top_level.txt +1 -0
kdcube_cli-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Elena Viter
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
kdcube_cli-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,133 @@
1
+ Metadata-Version: 2.4
2
+ Name: kdcube-cli
3
+ Version: 0.1.0
4
+ Summary: KDCube Apps bootstrap CLI
5
+ License: MIT License
6
+
7
+ Copyright (c) 2025 Elena Viter
8
+
9
+ Permission is hereby granted, free of charge, to any person obtaining a copy
10
+ of this software and associated documentation files (the "Software"), to deal
11
+ in the Software without restriction, including without limitation the rights
12
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
+ copies of the Software, and to permit persons to whom the Software is
14
+ furnished to do so, subject to the following conditions:
15
+
16
+ The above copyright notice and this permission notice shall be included in all
17
+ copies or substantial portions of the Software.
18
+
19
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25
+ SOFTWARE.
26
+
27
+ Requires-Python: >=3.9
28
+ Description-Content-Type: text/markdown
29
+ License-File: LICENSE
30
+ Requires-Dist: rich>=13.9.4
31
+ Dynamic: license-file
32
+
33
+ # KDCube CLI
34
+
35
+ ![KDCube CLI](https://raw.githubusercontent.com/kdcube/kdcube-ai-app/main/app/ai-app/services/kdcube-ai-app/kdcube_cli/pixel-cubes.png)
36
+
37
+ Bootstrap installer for the KDCube platform stack. This package clones the
38
+ repository (if needed) and launches the guided setup wizard.
39
+
40
+ CLI source: `services/kdcube-ai-app/kdcube_ai_app/ops/cli`
41
+ Packaged assets:
42
+ - `kdcube_cli/assets/pixel-cubes.svg`
43
+ - `kdcube_cli/assets/pixel-cubes.png`
44
+
45
+ ## Prerequisites
46
+
47
+ ### macOS
48
+ - Python 3.9+ (Homebrew recommended)
49
+ - Git (Xcode Command Line Tools or Homebrew)
50
+ - Docker Desktop (includes Docker Compose)
51
+
52
+ ### Windows
53
+ - Python 3.9+
54
+ - Git for Windows
55
+ - Docker Desktop (enable WSL2 backend)
56
+
57
+ ### Linux
58
+ - Python 3.9+
59
+ - Git
60
+ - Docker Engine + Docker Compose plugin
61
+
62
+ ## Install
63
+
64
+ ```bash
65
+ pipx install kdcube-cli
66
+ ```
67
+
68
+ Alternative (pip):
69
+
70
+ ```bash
71
+ python -m pip install --user kdcube-cli
72
+ ```
73
+
74
+ ## Run
75
+
76
+ ```bash
77
+ kdcube-setup
78
+ ```
79
+
80
+ Tip: if `kdcube-setup` is not on your PATH, run:
81
+
82
+ ```bash
83
+ python -m kdcube_cli.cli
84
+ ```
85
+
86
+ ## What the wizard does
87
+
88
+ - Creates a **workdir** with `config/`, `data/`, and `logs/` folders
89
+ - Writes the compose env files into `config/` (only if missing; it won’t overwrite existing files)
90
+ - Copies nginx configs into `config/` for runtime overrides:
91
+ - `nginx_ui.conf`
92
+ - `nginx_proxy.conf`
93
+ - Generates frontend runtime config
94
+ - Creates local data folders for Postgres/Redis/exec workspace/bundle storage
95
+ - Optionally builds images and runs `docker compose up -d --build`
96
+
97
+ ## Compose usage (recommended)
98
+
99
+ 1) Run the wizard and choose a workdir (example: `/srv/kdcube-local`).
100
+ 2) It will generate:
101
+ - `/srv/kdcube-local/config/.env`
102
+ - `/srv/kdcube-local/config/.env.ingress`
103
+ - `/srv/kdcube-local/config/.env.proc`
104
+ - `/srv/kdcube-local/config/.env.metrics`
105
+ - `/srv/kdcube-local/config/.env.postgres.setup`
106
+ - `/srv/kdcube-local/config/.env.proxylogin`
107
+ - `/srv/kdcube-local/config/frontend.config.hardcoded.json`
108
+ - `/srv/kdcube-local/config/nginx_ui.conf`
109
+ - `/srv/kdcube-local/config/nginx_proxy.conf`
110
+ 3) Start compose from `deployment/docker/all_in_one_kdcube`:
111
+
112
+ ```bash
113
+ docker compose --env-file /srv/kdcube-local/config/.env up -d --build
114
+ ```
115
+
116
+ Open the UI:
117
+ - `http://localhost:${KDCUBE_UI_PORT}/chatbot/chat` (via proxy, omit `:${KDCUBE_UI_PORT}` if it is `80`)
118
+
119
+ ## Dev‑host usage (run services on host)
120
+
121
+ You can still use the CLI to bootstrap a workdir and then run services locally:
122
+
123
+ 1) Run the wizard and choose a workdir.
124
+ 2) Point your IDE/run configs to the generated env files in `workdir/config`.
125
+ 3) The CLI also writes a dev UI config to:
126
+ - `app/ai-app/ui/chat-web-app/public/private/config.hardcoded.json`
127
+ 4) Start local infra via `deployment/docker/local-infra-stack` if needed.
128
+
129
+ Tip: you can edit `workdir/config/nginx_ui.conf` and `workdir/config/nginx_proxy.conf`
130
+ without rebuilding images (they are mounted into the containers at runtime).
131
+
132
+ See `app/ai-app/docs/service/environment/setup-dev-env-README.md` for the full
133
+ dev‑host flow.
kdcube_cli-0.1.0/README.md ADDED
@@ -0,0 +1,101 @@
1
+ # KDCube CLI
2
+
3
+ ![KDCube CLI](https://raw.githubusercontent.com/kdcube/kdcube-ai-app/main/app/ai-app/services/kdcube-ai-app/kdcube_cli/pixel-cubes.png)
4
+
5
+ Bootstrap installer for the KDCube platform stack. This package clones the
6
+ repository (if needed) and launches the guided setup wizard.
7
+
8
+ CLI source: `services/kdcube-ai-app/kdcube_ai_app/ops/cli`
9
+ Packaged assets:
10
+ - `kdcube_cli/assets/pixel-cubes.svg`
11
+ - `kdcube_cli/assets/pixel-cubes.png`
12
+
13
+ ## Prerequisites
14
+
15
+ ### macOS
16
+ - Python 3.9+ (Homebrew recommended)
17
+ - Git (Xcode Command Line Tools or Homebrew)
18
+ - Docker Desktop (includes Docker Compose)
19
+
20
+ ### Windows
21
+ - Python 3.9+
22
+ - Git for Windows
23
+ - Docker Desktop (enable WSL2 backend)
24
+
25
+ ### Linux
26
+ - Python 3.9+
27
+ - Git
28
+ - Docker Engine + Docker Compose plugin
29
+
30
+ ## Install
31
+
32
+ ```bash
33
+ pipx install kdcube-cli
34
+ ```
35
+
36
+ Alternative (pip):
37
+
38
+ ```bash
39
+ python -m pip install --user kdcube-cli
40
+ ```
41
+
42
+ ## Run
43
+
44
+ ```bash
45
+ kdcube-setup
46
+ ```
47
+
48
+ Tip: if `kdcube-setup` is not on your PATH, run:
49
+
50
+ ```bash
51
+ python -m kdcube_cli.cli
52
+ ```
53
+
54
+ ## What the wizard does
55
+
56
+ - Creates a **workdir** with `config/`, `data/`, and `logs/` folders
57
+ - Writes the compose env files into `config/` (only if missing; it won’t overwrite existing files)
58
+ - Copies nginx configs into `config/` for runtime overrides:
59
+ - `nginx_ui.conf`
60
+ - `nginx_proxy.conf`
61
+ - Generates frontend runtime config
62
+ - Creates local data folders for Postgres/Redis/exec workspace/bundle storage
63
+ - Optionally builds images and runs `docker compose up -d --build`
64
+
65
+ ## Compose usage (recommended)
66
+
67
+ 1) Run the wizard and choose a workdir (example: `/srv/kdcube-local`).
68
+ 2) It will generate:
69
+ - `/srv/kdcube-local/config/.env`
70
+ - `/srv/kdcube-local/config/.env.ingress`
71
+ - `/srv/kdcube-local/config/.env.proc`
72
+ - `/srv/kdcube-local/config/.env.metrics`
73
+ - `/srv/kdcube-local/config/.env.postgres.setup`
74
+ - `/srv/kdcube-local/config/.env.proxylogin`
75
+ - `/srv/kdcube-local/config/frontend.config.hardcoded.json`
76
+ - `/srv/kdcube-local/config/nginx_ui.conf`
77
+ - `/srv/kdcube-local/config/nginx_proxy.conf`
78
+ 3) Start compose from `deployment/docker/all_in_one_kdcube`:
79
+
80
+ ```bash
81
+ docker compose --env-file /srv/kdcube-local/config/.env up -d --build
82
+ ```
83
+
84
+ Open the UI:
85
+ - `http://localhost:${KDCUBE_UI_PORT}/chatbot/chat` (via proxy, omit `:${KDCUBE_UI_PORT}` if it is `80`)
86
+
87
+ ## Dev‑host usage (run services on host)
88
+
89
+ You can still use the CLI to bootstrap a workdir and then run services locally:
90
+
91
+ 1) Run the wizard and choose a workdir.
92
+ 2) Point your IDE/run configs to the generated env files in `workdir/config`.
93
+ 3) The CLI also writes a dev UI config to:
94
+ - `app/ai-app/ui/chat-web-app/public/private/config.hardcoded.json`
95
+ 4) Start local infra via `deployment/docker/local-infra-stack` if needed.
96
+
97
+ Tip: you can edit `workdir/config/nginx_ui.conf` and `workdir/config/nginx_proxy.conf`
98
+ without rebuilding images (they are mounted into the containers at runtime).
99
+
100
+ See `app/ai-app/docs/service/environment/setup-dev-env-README.md` for the full
101
+ dev‑host flow.
kdcube_cli-0.1.0/pyproject.toml ADDED
@@ -0,0 +1,21 @@
1
+ [build-system]
2
+ requires = ["setuptools>=67", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "kdcube-cli"
7
+ version = "0.1.0"
8
+ description = "KDCube Apps bootstrap CLI"
9
+ readme = "README.md"
10
+ requires-python = ">=3.9"
11
+ dependencies = ["rich>=13.9.4"]
12
+ license = {file = "LICENSE"}
13
+
14
+ [project.scripts]
15
+ kdcube-setup = "kdcube_cli.cli:main"
16
+
17
+ [tool.setuptools]
18
+ include-package-data = true
19
+
20
+ [tool.setuptools.package-data]
21
+ kdcube_cli = ["assets/*.svg", "assets/*.png"]
kdcube_cli-0.1.0/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
kdcube_cli-0.1.0/src/kdcube_cli/__init__.py ADDED
@@ -0,0 +1 @@
1
+ # SPDX-License-Identifier: MIT