pywebexec 2.0.5__py3-none-any.whl → 2.0.6__py3-none-any.whl

pywebexec/pywebexec.py

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

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/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/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/swagger.yaml

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

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.dist-info → pywebexec-2.0.6.dist-info}/METADATA

@@ -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.dist-info → pywebexec-2.0.6.dist-info}/RECORD

@@ -1,11 +1,11 @@
 pywebexec/__init__.py,sha256=197fHJy0UDBwTTpGCGortZRr-w2kTaD7MxqdbVmTEi0,61
 pywebexec/host_ip.py,sha256=Ud_HTflWVQ8789aoQ2RZdT1wGI-ccvrwSWGz_c7T3TI,1241
-pywebexec/pywebexec.py,sha256=BQtNhOJImk5jzAldE3XxQbkn4VHJ5kkGvWx4oLAxVsM,40741
-pywebexec/swagger.yaml,sha256=0fM22kXURoLi97xSncRuVBLaUB5iYA6ROkB9YaLrlwM,5861
-pywebexec/version.py,sha256=UwrRCi4EXT2M-9b7px4pzWAWypR42eEWODHeqQoFYpU,511
+pywebexec/pywebexec.py,sha256=bC9mOWBsOEVX_70BfJl6tF-4T0tm2WXcBvxcLprN4rw,40738
+pywebexec/swagger.yaml,sha256=j-KZnU4rGR-Fsk8y_EbqYzqVgtAZ8EjZIKAqZSxyyc0,5858
+pywebexec/version.py,sha256=Fo_Ssf3RDhryNW1qawxeulSMH8DrIVOcRvBytMAoNrc,511
 pywebexec/static/css/form.css,sha256=V8EeV7LTmIcbbi-lDdQ39SYNL02lWIOzYY9zyhJp204,3530
-pywebexec/static/css/markdown.css,sha256=CxvZsCt6h7VcNTeyrrEsZpd4VuTFmWA33Y68T2N0pOU,1881
-pywebexec/static/css/style.css,sha256=JBG_0DphjyZmFlno_-EeKzihl6KeDlhcQUb6RIx2RIA,9434
+pywebexec/static/css/markdown.css,sha256=3RzUnpVBdF6cQuB_NXV7hMTc0quYU8sfyuZcpsREj6A,1939
+pywebexec/static/css/style.css,sha256=o5iWsFOYtP1W-R_lTcWoaxzlh8EoaL__ycVZOori1Ws,9434
 pywebexec/static/css/swagger-ui.css,sha256=xhXN8fnUaIACGHuPIEIr9-qmyYr6Zx0k2wv4Qy7Bg1Y,154985
 pywebexec/static/css/swagger-ui.css.map,sha256=dJy-xBn_htK4BNupTMIl33ddse7BXsrCdDJWlTJodnw,258842
 pywebexec/static/css/xterm.css,sha256=uo5phWaUiJgcz0DAzv46uoByLLbJLeetYosL1xf68rY,5559
@@ -33,7 +33,7 @@ pywebexec/static/images/resume.svg,sha256=99LP1Ya2JXakRCO9kW8JMuT_4a_CannF65Eiuw
 pywebexec/static/images/running.svg,sha256=fBCYwYb2O9K4N3waC2nURP25NRwZlqR4PbDZy6JQMww,610
 pywebexec/static/images/success.svg,sha256=NVwezvVMplt46ElW798vqGfrL21Mw_DWHUp_qiD_FU8,489
 pywebexec/static/images/swagger-ui.svg,sha256=FR0yeOVwe4zCYKZAjCGcT_m0Mf25NexIVaSXifIkoU0,2117
-pywebexec/static/js/executables.js,sha256=NC5KZsq665oheVWVHTHRpr95iUHnLdF_Lck-obBXh3w,11728
+pywebexec/static/js/executables.js,sha256=iltgIJXWVUxAUhBfXGCHSP8mK8cQdtg-AagbGe7Hv9o,11762
 pywebexec/static/js/popup.js,sha256=0fr3pp4j9D2fXEVnHyQrx2bPWFHfgbb336dbewgH1d8,9023
 pywebexec/static/js/schemaform.js,sha256=bd874Geg9vri1c_seUGVynxZswGb5IcyWLZxYlcryCA,2784
 pywebexec/static/js/script.js,sha256=fwTo9Iz4xsl6wGs-Nm8-Ng8aXzDfvews5cHfzhSfg_0,17987
@@ -66,9 +66,9 @@ pywebexec/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSu
 pywebexec/templates/index.html,sha256=KeNLBH9PN_ZuGhzwrjvRTj2oBtbINv_SbwGQpOahNWo,3820
 pywebexec/templates/popup.html,sha256=3kpMccKD_OLLhJ4Y9KRw6Ny8wQWjVaRrUfV9y5-bDiQ,1580
 pywebexec/templates/swagger_ui.html,sha256=9ngyldkyEdLonBjl97mbIZUlVk-jxwcHrvFzMSrveyU,1067
-pywebexec-2.0.5.dist-info/LICENSE,sha256=gRJf0JPT_wsZJsUGlWPTS8Vypfl9vQ1qjp6sNbKykuA,1064
-pywebexec-2.0.5.dist-info/METADATA,sha256=kD2sukHFymHzkEPXIVjI91SnNaECKRhedjP8Mx0KRb8,9644
-pywebexec-2.0.5.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-pywebexec-2.0.5.dist-info/entry_points.txt,sha256=l52GBkPCXRkmlHfEyoVauyfBdg8o-CAtC8qQpOIjJK0,55
-pywebexec-2.0.5.dist-info/top_level.txt,sha256=vHoHyzngrfGdm_nM7Xn_5iLmaCrf10XO1EhldgNLEQ8,10
-pywebexec-2.0.5.dist-info/RECORD,,
+pywebexec-2.0.6.dist-info/LICENSE,sha256=gRJf0JPT_wsZJsUGlWPTS8Vypfl9vQ1qjp6sNbKykuA,1064
+pywebexec-2.0.6.dist-info/METADATA,sha256=Fhj5kZ-HH8yPPDp72ES7MAMJ-6_RkHVFzzVv-_aRMM4,11615
+pywebexec-2.0.6.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
+pywebexec-2.0.6.dist-info/entry_points.txt,sha256=l52GBkPCXRkmlHfEyoVauyfBdg8o-CAtC8qQpOIjJK0,55
+pywebexec-2.0.6.dist-info/top_level.txt,sha256=vHoHyzngrfGdm_nM7Xn_5iLmaCrf10XO1EhldgNLEQ8,10
+pywebexec-2.0.6.dist-info/RECORD,,