pywebexec 2.0.5__tar.gz → 2.0.6__tar.gz

{pywebexec-2.0.5/pywebexec.egg-info → pywebexec-2.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pywebexec
-Version: 2.0.5
+Version: 2.0.6
 Summary: Simple Python HTTP Exec Server
 Home-page: https://github.com/joknarf/pywebexec
 Author: Franck Jouvanceau
@@ -208,12 +208,67 @@ The help message is displayed:
 
 <img src="https://github.com/user-attachments/assets/2d69cef2-3371-4282-99bb-e994eb0c0b24" width="400"/>
 
+## Add schema to commands
+
+For each exposed command, you can add a schema by creating a file named `<command>.schema.yaml` in the same directory as the command. The schema must be written in yaml format.  
+The schema is used to generate a form in the web interface and in the swagger-ui in the `/commands/<command>` route.  
+The schema is also used to validate the input parameters when calling the API `/commands/<command>`.  
+The schema must be written in the openapi schema format.
+
+```yaml
+type: object
+properties:
+  param1:
+    type: string
+    description: "param1 description"
+    example: "value"
+  param2:
+    type: integer
+    description: "param2 description"
+    enum: [1, 2, 3]
+  param3:
+    type: array
+    items:
+      type: string
+    description: "param3 description"
+    example: ["value1", "value2"]
+required:
+  - param1
+  - param2
+```
+The payload will be converted to command line arguments when calling the command.
+```
+command --param1 value --param2 1 --param3 value1 value2
+```
+
+* On the web inferface, and swagger-ui the form will be generated from the schema.
+
+<img src="https://github.com/user-attachments/assets/c7cdf117-aa38-4366-97c7-1aa26e5ebf0d" width=400>
+
+When using schema, the command can now be launched with:
+```
+$ curl -X POST http://<srv>/commands/<cmd> -H "Content-Type: application/json" -d '{"param1": "value", "param2": 1, "param3": ["value1", "value2"]}'
+```
+
+## Schema options
+
+The schema options are used to customize the command line arguments generation, just add a `schema_options` section to the schema.
+```yaml
+schema_options:
+  separator: "=" # --param=value (default is " ") 
+  noprefix_params: ["param1", "param2"] # omit --param prefix, use "*" to omit all
+  convert_params: {"param1": "param2"} # convert param1 to param2
+```
+
 ## Swagger UI
 
-A swagger UI is available at `http[s]://<srv>/v0/documentation`
+A custom swagger UI is available at `http[s]://<srv>/v0/documentation` with enhanced markdown rendering and form generation for body parameters.
 
 <img src="https://github.com/user-attachments/assets/c80a341e-c04c-4606-9510-a57b473a74e5" width="400"/>
 
+<img src="https://github.com/user-attachments/assets/22261048-459e-4ace-8d04-c568d67bef37" width="400">
+
+
 ## API reference
 
 

{pywebexec-2.0.5 → pywebexec-2.0.6}/README.md

@@ -145,12 +145,67 @@ The help message is displayed:
 
 <img src="https://github.com/user-attachments/assets/2d69cef2-3371-4282-99bb-e994eb0c0b24" width="400"/>
 
+## Add schema to commands
+
+For each exposed command, you can add a schema by creating a file named `<command>.schema.yaml` in the same directory as the command. The schema must be written in yaml format.  
+The schema is used to generate a form in the web interface and in the swagger-ui in the `/commands/<command>` route.  
+The schema is also used to validate the input parameters when calling the API `/commands/<command>`.  
+The schema must be written in the openapi schema format.
+
+```yaml
+type: object
+properties:
+  param1:
+    type: string
+    description: "param1 description"
+    example: "value"
+  param2:
+    type: integer
+    description: "param2 description"
+    enum: [1, 2, 3]
+  param3:
+    type: array
+    items:
+      type: string
+    description: "param3 description"
+    example: ["value1", "value2"]
+required:
+  - param1
+  - param2
+```
+The payload will be converted to command line arguments when calling the command.
+```
+command --param1 value --param2 1 --param3 value1 value2
+```
+
+* On the web inferface, and swagger-ui the form will be generated from the schema.
+
+<img src="https://github.com/user-attachments/assets/c7cdf117-aa38-4366-97c7-1aa26e5ebf0d" width=400>
+
+When using schema, the command can now be launched with:
+```
+$ curl -X POST http://<srv>/commands/<cmd> -H "Content-Type: application/json" -d '{"param1": "value", "param2": 1, "param3": ["value1", "value2"]}'
+```
+
+## Schema options
+
+The schema options are used to customize the command line arguments generation, just add a `schema_options` section to the schema.
+```yaml
+schema_options:
+  separator: "=" # --param=value (default is " ") 
+  noprefix_params: ["param1", "param2"] # omit --param prefix, use "*" to omit all
+  convert_params: {"param1": "param2"} # convert param1 to param2
+```
+
 ## Swagger UI
 
-A swagger UI is available at `http[s]://<srv>/v0/documentation`
+A custom swagger UI is available at `http[s]://<srv>/v0/documentation` with enhanced markdown rendering and form generation for body parameters.
 
 <img src="https://github.com/user-attachments/assets/c80a341e-c04c-4606-9510-a57b473a74e5" width="400"/>
 
+<img src="https://github.com/user-attachments/assets/22261048-459e-4ace-8d04-c568d67bef37" width="400">
+
+
 ## API reference
 
 

{pywebexec-2.0.5 → pywebexec-2.0.6}/pywebexec/pywebexec.py

@@ -1007,7 +1007,7 @@ def swagger_yaml():
                     "parameters": [
                         {
                             "in": "body",
-                            "name": "commandRequest",
+                            "name": "reuqestBody",
                             "schema": cmd_schema
                         }
                     ],

{pywebexec-2.0.5 → pywebexec-2.0.6}/pywebexec/static/css/markdown.css

@@ -66,9 +66,14 @@
         font-size: 14px;
         color: #333;
         background-color: #dfdfff;
-        padding: 1px 4px;
         border-radius: 5px;
     }
+    code {
+        padding: 1px 4px;
+    }
+    pre code {
+        padding: 0;
+    }
     pre {
         padding: 5px 10px;
         border-radius: 10px;

{pywebexec-2.0.5 → pywebexec-2.0.6}/pywebexec/static/css/style.css

@@ -420,7 +420,7 @@ body.dimmed * {
     font-size: 13px;
 }
 .command-line {
-  padding: 6px 10px 6px 10px;
+  padding: 5px 10px 6px 10px;
   background-color: #111;
   color: #eee;
   max-width: 300px;
@@ -429,7 +429,7 @@ body.dimmed * {
   overflow: hidden;
   text-overflow: ellipsis;
   font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif;
-  font-size: 13px;
+  font-size: 14px;
 }
 
 .nbrunning {

{pywebexec-2.0.5 → pywebexec-2.0.6}/pywebexec/static/js/executables.js

@@ -34,7 +34,7 @@ function filterCommands() {
             items[i].style.display = 'none';
         }
     }
-    if (nbVisibleItems > 1) {
+    if (nbVisibleItems > 1 || commandInput.value.length == 0) {
         commandListDiv.style.display = 'block';
     } else {
         commandListDiv.style.display = 'none';

{pywebexec-2.0.5 → pywebexec-2.0.6}/pywebexec/swagger.yaml

@@ -47,7 +47,7 @@ paths:
         - application/json
       parameters:
         - in: body
-          name: commandRequest
+          name: requestBody
           schema:
             type: object
             properties:

{pywebexec-2.0.5 → pywebexec-2.0.6}/pywebexec/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.0.5'
-__version_tuple__ = version_tuple = (2, 0, 5)
+__version__ = version = '2.0.6'
+__version_tuple__ = version_tuple = (2, 0, 6)

{pywebexec-2.0.5 → pywebexec-2.0.6/pywebexec.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pywebexec
-Version: 2.0.5
+Version: 2.0.6
 Summary: Simple Python HTTP Exec Server
 Home-page: https://github.com/joknarf/pywebexec
 Author: Franck Jouvanceau
@@ -208,12 +208,67 @@ The help message is displayed:
 
 <img src="https://github.com/user-attachments/assets/2d69cef2-3371-4282-99bb-e994eb0c0b24" width="400"/>
 
+## Add schema to commands
+
+For each exposed command, you can add a schema by creating a file named `<command>.schema.yaml` in the same directory as the command. The schema must be written in yaml format.  
+The schema is used to generate a form in the web interface and in the swagger-ui in the `/commands/<command>` route.  
+The schema is also used to validate the input parameters when calling the API `/commands/<command>`.  
+The schema must be written in the openapi schema format.
+
+```yaml
+type: object
+properties:
+  param1:
+    type: string
+    description: "param1 description"
+    example: "value"
+  param2:
+    type: integer
+    description: "param2 description"
+    enum: [1, 2, 3]
+  param3:
+    type: array
+    items:
+      type: string
+    description: "param3 description"
+    example: ["value1", "value2"]
+required:
+  - param1
+  - param2
+```
+The payload will be converted to command line arguments when calling the command.
+```
+command --param1 value --param2 1 --param3 value1 value2
+```
+
+* On the web inferface, and swagger-ui the form will be generated from the schema.
+
+<img src="https://github.com/user-attachments/assets/c7cdf117-aa38-4366-97c7-1aa26e5ebf0d" width=400>
+
+When using schema, the command can now be launched with:
+```
+$ curl -X POST http://<srv>/commands/<cmd> -H "Content-Type: application/json" -d '{"param1": "value", "param2": 1, "param3": ["value1", "value2"]}'
+```
+
+## Schema options
+
+The schema options are used to customize the command line arguments generation, just add a `schema_options` section to the schema.
+```yaml
+schema_options:
+  separator: "=" # --param=value (default is " ") 
+  noprefix_params: ["param1", "param2"] # omit --param prefix, use "*" to omit all
+  convert_params: {"param1": "param2"} # convert param1 to param2
+```
+
 ## Swagger UI
 
-A swagger UI is available at `http[s]://<srv>/v0/documentation`
+A custom swagger UI is available at `http[s]://<srv>/v0/documentation` with enhanced markdown rendering and form generation for body parameters.
 
 <img src="https://github.com/user-attachments/assets/c80a341e-c04c-4606-9510-a57b473a74e5" width="400"/>
 
+<img src="https://github.com/user-attachments/assets/22261048-459e-4ace-8d04-c568d67bef37" width="400">
+
+
 ## API reference