pywebexec 1.9.6__py3-none-any.whl → 1.9.8__py3-none-any.whl

pywebexec/pywebexec.py

@@ -766,6 +766,12 @@ def run_command_endpoint():
 
     return jsonify({'message': 'Command is running', 'command_id': command_id})
 
+@app.route('/commands/exposed', methods=['GET'])
+def list_executables():
+    executables_list = get_executables()
+    return jsonify({"commands": executables_list})
+
+
 @app.route('/commands/<cmd>', methods=['POST'])
 def run_dynamic_command(cmd):
     # Validate that 'cmd' is an executable in the current directory
@@ -871,10 +877,6 @@ def get_command_output_raw(command_id):
             return
     return Response(generate(offset), content_type='text/plain')
 
-@app.route('/executables', methods=['GET'])
-def list_executables():
-    executables_list = get_executables()
-    return jsonify({"executables": executables_list})
 
 @app.route('/commands/<command_id>/popup')
 def popup(command_id):
@@ -923,6 +925,7 @@ def swagger_yaml():
             swagger_spec.setdefault("paths", {})[dynamic_path] = {
                 "post": {
                     "summary": f"Run command {exe["command"]}",
+                    "tags": ["run_commands"],
                     "description": f"{exe["help"]}",
                     "consumes": ["application/json"],
                     "produces": ["application/json"],

pywebexec/static/js/executables.js

@@ -225,7 +225,7 @@ window.addEventListener('load', () => {
 
 async function fetchExecutables() {
     try {
-        const response = await fetch(`/executables`);
+        const response = await fetch(`/commands/exposed`);
         if (!response.ok) {
             throw new Error('Failed to fetch executables');
         }
@@ -233,7 +233,7 @@ async function fetchExecutables() {
         // Build mapping from executable name to its object
         gExecutables = {};
         commandListDiv.innerHTML = '';
-        data.executables.forEach(exeObj => {
+        data.commands.forEach(exeObj => {
             gExecutables[exeObj.command] = exeObj;
             const div = document.createElement('div');
             div.className = 'command-item';

pywebexec/swagger.yaml

@@ -6,6 +6,8 @@ paths:
   /commands:
     get:
       summary: "List commands status"
+      tags:
+        - commands
       responses:
         "200":
           description: "List of all commands status"
@@ -37,6 +39,8 @@ paths:
                       type: string
     post:
       summary: "Run a command"
+      tags:
+        - commands
       consumes:
         - application/json
       produces:
@@ -77,6 +81,8 @@ paths:
   /commands/{command_id}:
     get:
       summary: "Get command status"
+      tags:
+        - commands
       parameters:
         - in: path
           name: command_id
@@ -122,6 +128,8 @@ paths:
   /commands/{command_id}/output:
     get:
       summary: "Get command output"
+      tags:
+        - commands
       parameters:
         - in: path
           name: command_id
@@ -167,6 +175,8 @@ paths:
   /commands/{command_id}/stop:
     patch:
       summary: "Stop a running command"
+      tags:
+        - commands
       parameters:
         - in: path
           name: command_id
@@ -180,18 +190,20 @@ paths:
             properties:
               message:
                 type: string
-  /executables:
+  /commands/exposed:
     get:
       summary: "List available executable commands"
+      tags:
+        - commands
       produces:
         - application/json
       responses:
         "200":
-          description: "List of executables returned as an array of executable objects"
+          description: "List of commands with markdown help"
           schema:
             type: object
             properties:
-              executables:
+              commands:
                 type: array
                 items:
                   type: object
@@ -202,8 +214,8 @@ paths:
                       type: string
           examples:
             application/json:
-              executables:
+              commands:
                 - command: ls
-                  help: "List directory contents\nparams:\n  <ls_params>"
+                  help: "List directory contents \n**params**:\n* `<ls_params>`"
                 - command: cat
-                  help: "Concatenate and display files\nparams:\n  <cat_params>"
+                  help: "Concatenate and display files \n**params**:\n* `<cat_params>`"

pywebexec/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.9.6'
-__version_tuple__ = version_tuple = (1, 9, 6)
+__version__ = version = '1.9.8'
+__version_tuple__ = version_tuple = (1, 9, 8)

{pywebexec-1.9.6.dist-info → pywebexec-1.9.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pywebexec
-Version: 1.9.6
+Version: 1.9.8
 Summary: Simple Python HTTP Exec Server
 Home-page: https://github.com/joknarf/pywebexec
 Author: Franck Jouvanceau
@@ -213,18 +213,19 @@ The help message is displayed:
 
 A swagger UI is available at `http[s]://<srv>/v0/documentation`
 
-<img src="https://github.com/user-attachments/assets/759e889a-8fef-4f49-9319-d2d9dbaf7e69" width="400"/>
+<img src="https://github.com/user-attachments/assets/c80a341e-c04c-4606-9510-a57b473a74e5" width="400"/>
 
 ## API reference
 
 
 | method    | route                       | params/payload     | returns
 |-----------|-----------------------------|--------------------|---------------------|
-| GET       | /executables                |                    | executables: [<br>&nbsp;&nbsp;{command: str,help: str},<br>]        |
+| GET       | /commands/exposed           |                    | executables: [<br>&nbsp;&nbsp;{command: str,help: str},<br>]        |
 | GET       | /commands                   |                    | commands: [<br>&nbsp;&nbsp;{<br>&nbsp;&nbsp;&nbsp;&nbsp;command_id: uuid<br>&nbsp;&nbsp;&nbsp;&nbsp;command: str<br>&nbsp;&nbsp;&nbsp;&nbsp;start_time: isotime<br>&nbsp;&nbsp;&nbsp;&nbsp;end_time: isotime<br>&nbsp;&nbsp;&nbsp;&nbsp;status: str<br>&nbsp;&nbsp;&nbsp;&nbsp;exit_code: int<br>&nbsp;&nbsp;&nbsp;&nbsp;last_output_line: str<br>&nbsp;&nbsp;},<br>]      |
-| GET       | /commands/{id}  |                    | command_id: uuid<br>command: str<br>params: array[str]<br>start_time: isotime<br>end_time: isotime<br>status: str<br>exit_code: int<br>last_output_line: str      |
-| GET       | /commands/{id}/output    | offset: int        | output: str<br>status: str<br>links: { next: str }         |
-| GET       | /commands/{id}/output_raw  | offset: int        | output: stream raw output until end of command<br>curl -Ns http://srv/commands/{id}/output_raw|
-| POST      | /commands                | command: str<br>params: array[str]<br>rows: int<br>cols: int       | command_id: uuid<br>message: str    |
-| POST      | /commands/{cmd}       | params: array[str]<br>rows: int<br>cols: int       | command_id: uuid<br>message: str    |
-| PATCH      | /commands/{id}/stop    |                    | message: str        |
+| GET       | /commands/{id}              |                    | command_id: uuid<br>command: str<br>params: array[str]<br>start_time: isotime<br>end_time: isotime<br>status: str<br>exit_code: int<br>last_output_line: str      |
+| GET       | /commands/{id}/output       | offset: int        | output: str<br>status: str<br>links: { next: str }         |
+| GET       | /commands/{id}/output_raw   | offset: int        | output: stream raw output until end of command<br>curl -Ns http://srv/commands/{id}/output_raw|
+| POST      | /commands                   | command: str<br>params: array[str]<br>rows: int<br>cols: int       | command_id: uuid<br>message: str    |
+| POST      | /commands/{cmd}             | params: array[str]<br>rows: int<br>cols: int       | command_id: uuid<br>message: str    |
+| PATCH     | /commands/{id}/stop        |                    | message: str        |
+

{pywebexec-1.9.6.dist-info → pywebexec-1.9.8.dist-info}/RECORD

@@ -1,8 +1,8 @@
 pywebexec/__init__.py,sha256=197fHJy0UDBwTTpGCGortZRr-w2kTaD7MxqdbVmTEi0,61
 pywebexec/host_ip.py,sha256=Ud_HTflWVQ8789aoQ2RZdT1wGI-ccvrwSWGz_c7T3TI,1241
-pywebexec/pywebexec.py,sha256=Jl-23-mSKubf31I5XsyC5Lp4fgI5VHLfE3UVSynzZsE,37933
-pywebexec/swagger.yaml,sha256=w5Jl1S9yKhXZ5oaUunX8DJBToUGb9vsxvJE-K4KMNNA,5504
-pywebexec/version.py,sha256=I92J40df6ONedQ3XmqUGatZtaiiCjGjsjRS83cvq8Ek,511
+pywebexec/pywebexec.py,sha256=SU-iD3FQIyWsw0-iGjM2P8INpBW9JhzZ1lI3Y50Fwqk,37983
+pywebexec/swagger.yaml,sha256=pGG4ikpASgBnzoZ44jJJ8l5JrNz7GOBpCakSJta-30c,5676
+pywebexec/version.py,sha256=70T59qHdyEgYEEdFJ1UeLYBCA8Ap6rFY6TI0tAG2O2k,511
 pywebexec/static/css/style.css,sha256=M2zqrDSolDUxeVVeJ0e6NMTMM8B4_LUEmG-lWQwtUoI,9530
 pywebexec/static/css/xterm.css,sha256=uo5phWaUiJgcz0DAzv46uoByLLbJLeetYosL1xf68rY,5559
 pywebexec/static/fonts/CommitMonoNerdFontMono-Regular.ttf,sha256=v6nZdSx5cs_TIic8Fujrjzg9u9glWjorDIr7RlwNceM,2370228
@@ -23,7 +23,7 @@ pywebexec/static/images/popup.svg,sha256=0Bl9A_v5cBsMPn6FnOlVWlAQKgd2zqiWQbhjcL9
 pywebexec/static/images/resume.svg,sha256=99LP1Ya2JXakRCO9kW8JMuT_4a_CannF65EiuwtvK4A,607
 pywebexec/static/images/running.svg,sha256=fBCYwYb2O9K4N3waC2nURP25NRwZlqR4PbDZy6JQMww,610
 pywebexec/static/images/success.svg,sha256=NVwezvVMplt46ElW798vqGfrL21Mw_DWHUp_qiD_FU8,489
-pywebexec/static/js/executables.js,sha256=Dalcybfllp1GdZT6WCfQ96U4GAwZ0Aqiv4_LfhOeP3Y,9471
+pywebexec/static/js/executables.js,sha256=ISRtkAlpjv3agIbTc3MIKV62g22h6NQW8stxA43ZD9Y,9473
 pywebexec/static/js/popup.js,sha256=0fr3pp4j9D2fXEVnHyQrx2bPWFHfgbb336dbewgH1d8,9023
 pywebexec/static/js/script.js,sha256=EpDwM1CyvHgsfkMSAkYmS9nU0sKOEXpQ6L3xhDIabEY,17933
 pywebexec/static/js/marked/LICENSE.md,sha256=jjo_gvWaYJWPVsoI9EVkfDKkcz3HymwsRvbriYRxq5w,2942
@@ -42,9 +42,9 @@ pywebexec/static/js/xterm/xterm.js.map,sha256=Y7O2Pb-fIS7Z8AC1D5s04_aiW_Jf1f4mCf
 pywebexec/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pywebexec/templates/index.html,sha256=66Oevi5umxCK81IoGoudx3vWp0ltdFMFsymXsnLQw-c,3209
 pywebexec/templates/popup.html,sha256=3kpMccKD_OLLhJ4Y9KRw6Ny8wQWjVaRrUfV9y5-bDiQ,1580
-pywebexec-1.9.6.dist-info/LICENSE,sha256=gRJf0JPT_wsZJsUGlWPTS8Vypfl9vQ1qjp6sNbKykuA,1064
-pywebexec-1.9.6.dist-info/METADATA,sha256=lJyuzla4QUvEEXWqEAHOwWVriLBEOatOay3VgTLDiWU,9450
-pywebexec-1.9.6.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-pywebexec-1.9.6.dist-info/entry_points.txt,sha256=l52GBkPCXRkmlHfEyoVauyfBdg8o-CAtC8qQpOIjJK0,55
-pywebexec-1.9.6.dist-info/top_level.txt,sha256=vHoHyzngrfGdm_nM7Xn_5iLmaCrf10XO1EhldgNLEQ8,10
-pywebexec-1.9.6.dist-info/RECORD,,
+pywebexec-1.9.8.dist-info/LICENSE,sha256=gRJf0JPT_wsZJsUGlWPTS8Vypfl9vQ1qjp6sNbKykuA,1064
+pywebexec-1.9.8.dist-info/METADATA,sha256=ELM9BreZt2lJ2u-2QhY5sJ1ukVmvK2FfZltv07rFcJo,9479
+pywebexec-1.9.8.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+pywebexec-1.9.8.dist-info/entry_points.txt,sha256=l52GBkPCXRkmlHfEyoVauyfBdg8o-CAtC8qQpOIjJK0,55
+pywebexec-1.9.8.dist-info/top_level.txt,sha256=vHoHyzngrfGdm_nM7Xn_5iLmaCrf10XO1EhldgNLEQ8,10
+pywebexec-1.9.8.dist-info/RECORD,,