oak-cli 0.2.5__tar.gz → 0.2.6__tar.gz

oak_cli-0.2.6/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.1
+Name: oak_cli
+Version: 0.2.6
+Summary: 
+Author: Alexander Malyuk
+Author-email: malyuk.alexander1999@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: argcomplete (>=3.2.3,<4.0.0)
+Description-Content-Type: text/markdown
+
+# [Oakestra CLI](https://github.com/oakestra/oakestra-cli)
+
+**oakestra-cli** is a very basic command line tool for controlling your [Oakestra](https://github.com/oakestra/oakestra) setup. 
+
+It is intended to be a interface for the API as well as a development tool.
+
+The CLI supports command (tab) autocompletion.
+
+## Usage
+The package can be called via `oak`.
+
+Currently it supports the creation, deletion, inspection, and (un)deployment of applications and services.
+
+E.g. To deploy a default application with two services:
+```
+oak applications create default_app_with_services --deploy
+```
+Note: The CLI supports short command aliases. The command above can be shortened like this:
+```
+oak a c default_app_with_services -d
+```
+
+You should see a similar output if the command was successful:
+```bash
+Success: Create new application based on 'default_app_with_services'
+Success: Deploy a new instance for the service '66040243c7723114bb83b914'
+Success: Deploy a new instance for the service '66040243c7723114bb83b919'
+```
+You can inspect the services like this:
+```bash
+oak services status
+```
+Or like this: `oak s s`
+
+Service status output:
+```yaml
+All current services: '2'
+ Service '0':
+   - microservice -
+   id: '66040243c7723114bb83b914'
+   name: 'curl'
+   ns: 'test'
+   parent app: 'clientsrvr: 660402439df62d60bb95452b'
+   - resources -
+   memory: '100'
+   vcpus: '1'
+   - container -
+   image: 'docker.io/curlimages/curl:7.82.0'
+   - networking -
+   port: '9080'
+   - instances -
+   instances: '1'
+ Service '1':
+   - microservice -
+   id: '66040243c7723114bb83b919'
+   name: 'nginx'
+   ns: 'test'
+   parent app: 'clientsrvr: 660402439df62d60bb95452b'
+   - resources -
+   memory: '100'
+   vcpus: '1'
+   - container -
+   image: 'docker.io/library/nginx:latest'
+   - networking -
+   port: '6080:60/tcp'
+   - instances -
+   instances: '1'
+```
+
+For a more detailed explanation have a try out the CLI and use the `-h` flag.
+
+## [Installation](https://pypi.org/project/oak-cli/)
+```
+pip install oak-cli
+```
+
+# For CLI Contributors/Developers
+For local development with "hot-reload" functionality simply install the package via poetry.
+
+## Useful commands
+
+```bash
+poetry install
+```
+```bash
+poetry build
+```
+```
+twine upload dist/*
+```
+

oak_cli-0.2.6/README.md

@@ -0,0 +1,90 @@
+# [Oakestra CLI](https://github.com/oakestra/oakestra-cli)
+
+**oakestra-cli** is a very basic command line tool for controlling your [Oakestra](https://github.com/oakestra/oakestra) setup. 
+
+It is intended to be a interface for the API as well as a development tool.
+
+The CLI supports command (tab) autocompletion.
+
+## Usage
+The package can be called via `oak`.
+
+Currently it supports the creation, deletion, inspection, and (un)deployment of applications and services.
+
+E.g. To deploy a default application with two services:
+```
+oak applications create default_app_with_services --deploy
+```
+Note: The CLI supports short command aliases. The command above can be shortened like this:
+```
+oak a c default_app_with_services -d
+```
+
+You should see a similar output if the command was successful:
+```bash
+Success: Create new application based on 'default_app_with_services'
+Success: Deploy a new instance for the service '66040243c7723114bb83b914'
+Success: Deploy a new instance for the service '66040243c7723114bb83b919'
+```
+You can inspect the services like this:
+```bash
+oak services status
+```
+Or like this: `oak s s`
+
+Service status output:
+```yaml
+All current services: '2'
+ Service '0':
+   - microservice -
+   id: '66040243c7723114bb83b914'
+   name: 'curl'
+   ns: 'test'
+   parent app: 'clientsrvr: 660402439df62d60bb95452b'
+   - resources -
+   memory: '100'
+   vcpus: '1'
+   - container -
+   image: 'docker.io/curlimages/curl:7.82.0'
+   - networking -
+   port: '9080'
+   - instances -
+   instances: '1'
+ Service '1':
+   - microservice -
+   id: '66040243c7723114bb83b919'
+   name: 'nginx'
+   ns: 'test'
+   parent app: 'clientsrvr: 660402439df62d60bb95452b'
+   - resources -
+   memory: '100'
+   vcpus: '1'
+   - container -
+   image: 'docker.io/library/nginx:latest'
+   - networking -
+   port: '6080:60/tcp'
+   - instances -
+   instances: '1'
+```
+
+For a more detailed explanation have a try out the CLI and use the `-h` flag.
+
+## [Installation](https://pypi.org/project/oak-cli/)
+```
+pip install oak-cli
+```
+
+# For CLI Contributors/Developers
+For local development with "hot-reload" functionality simply install the package via poetry.
+
+## Useful commands
+
+```bash
+poetry install
+```
+```bash
+poetry build
+```
+```
+twine upload dist/*
+```

{oak_cli-0.2.5 → oak_cli-0.2.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "oak_cli"
-version = "0.2.5"
+version = "0.2.6"
 description = ""
 authors = ["Alexander Malyuk <malyuk.alexander1999@gmail.com>"]
 readme = "README.md"

oak_cli-0.2.5/PKG-INFO

@@ -1,98 +0,0 @@
-Metadata-Version: 2.1
-Name: oak_cli
-Version: 0.2.5
-Summary: 
-Author: Alexander Malyuk
-Author-email: malyuk.alexander1999@gmail.com
-Requires-Python: >=3.10,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: argcomplete (>=3.2.3,<4.0.0)
-Description-Content-Type: text/markdown
-
-# Oakestra CLI
-
-> NM: Rename system commands to Oakestra
-
-**oakestra-cli** is a very basic command line tool for controlling the EdgeIO framework.
-
-## Installation
-
-Use the package manager [pip](https://pip.pypa.io/en/stable/) and the .whl file in the dist directory to install
-edgeiocli.
-
-```bash
-pip install edgeiocli-0.1.0-py3-none-any.whl
-```
-
-## Build
-
-Use the package [poetry](https://python-poetry.org/) to build the tool and create a new .whl file.
-
-Updates the dependency's: 
-```bash
-poetry update
-```
-
-Installs the package:
-```bash
-poetry install
-```
-
-Creates the .whl file:
-```bash
-poetry build
-```
-
-## Usage
-
-```bash
-edgeiocli COMMAND [ARGS] [OPTIONS] 
-
-# Try 'edgeiocli --help' for help.
-```
-
-## Available Commands
-
-- `login [USERNAME]` logs the user into the system and creates access token
-- `logout` logs out the user and deletes the token
-- `change-password` changes the password of the user
-- `application [COMMAND]`
-    - `create` creates a new application
-    - `delete [APPLICATION_ID]` deletes a application
-    - `list-jobs [APPLICATION_ID]` displays all jobs in the application
-    - `list` displays all applications of the user
-- `service [COMMAND]`
-    - `delete [SERVICE_ID]` deletes the job
-    - `create [PATH]` creates a new service
-    - `deploy [SERVICE_ID]` tries to deploy a service
-- `user  [COMMAND]`
-    - `create --role [Admin | Application_Provider | Infrastructure_Provider]` creates a new user
-    - `delete [USERNAME] deletes the user`
-    - `list` displays all user of the system
-    - `set-roles [USERNAME] --role [Admin | Application_Provider | Infrastructure_Provider]`
-
-## Deployment
-The given json file should contain only a microservice configuration, as in the example, all the application and user information will be added automatically.  
-
-```
-{
-      ...
-      "microservice_name": "service",
-      "microservice_namespace": "dev",
-      "virtualization": "docker",
-      "memory": 100,
-      ...
-}
-
-```
-
-## Contributing
-
-This is the first version of **oakestra-cli** and does not yet offer all features, also there
-might be some bugs, if you find one please report it or fix it. 
-
-To add a new command create a function in the main.py file and add the `@app.command()` annotation to the function. If you want to create sub commands, create the command in the corresponding file. 
-

oak_cli-0.2.5/README.md

@@ -1,83 +0,0 @@
-# Oakestra CLI
-
-> NM: Rename system commands to Oakestra
-
-**oakestra-cli** is a very basic command line tool for controlling the EdgeIO framework.
-
-## Installation
-
-Use the package manager [pip](https://pip.pypa.io/en/stable/) and the .whl file in the dist directory to install
-edgeiocli.
-
-```bash
-pip install edgeiocli-0.1.0-py3-none-any.whl
-```
-
-## Build
-
-Use the package [poetry](https://python-poetry.org/) to build the tool and create a new .whl file.
-
-Updates the dependency's: 
-```bash
-poetry update
-```
-
-Installs the package:
-```bash
-poetry install
-```
-
-Creates the .whl file:
-```bash
-poetry build
-```
-
-## Usage
-
-```bash
-edgeiocli COMMAND [ARGS] [OPTIONS] 
-
-# Try 'edgeiocli --help' for help.
-```
-
-## Available Commands
-
-- `login [USERNAME]` logs the user into the system and creates access token
-- `logout` logs out the user and deletes the token
-- `change-password` changes the password of the user
-- `application [COMMAND]`
-    - `create` creates a new application
-    - `delete [APPLICATION_ID]` deletes a application
-    - `list-jobs [APPLICATION_ID]` displays all jobs in the application
-    - `list` displays all applications of the user
-- `service [COMMAND]`
-    - `delete [SERVICE_ID]` deletes the job
-    - `create [PATH]` creates a new service
-    - `deploy [SERVICE_ID]` tries to deploy a service
-- `user  [COMMAND]`
-    - `create --role [Admin | Application_Provider | Infrastructure_Provider]` creates a new user
-    - `delete [USERNAME] deletes the user`
-    - `list` displays all user of the system
-    - `set-roles [USERNAME] --role [Admin | Application_Provider | Infrastructure_Provider]`
-
-## Deployment
-The given json file should contain only a microservice configuration, as in the example, all the application and user information will be added automatically.  
-
-```
-{
-      ...
-      "microservice_name": "service",
-      "microservice_namespace": "dev",
-      "virtualization": "docker",
-      "memory": 100,
-      ...
-}
-
-```
-
-## Contributing
-
-This is the first version of **oakestra-cli** and does not yet offer all features, also there
-might be some bugs, if you find one please report it or fix it. 
-
-To add a new command create a function in the main.py file and add the `@app.command()` annotation to the function. If you want to create sub commands, create the command in the corresponding file.