pywebexec 1.9.7__tar.gz → 1.9.8__tar.gz

{pywebexec-1.9.7/pywebexec.egg-info → pywebexec-1.9.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pywebexec
-Version: 1.9.7
+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/60649510-4edb-4275-9339-181b451c603b" 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.7 → pywebexec-1.9.8}/README.md

@@ -149,18 +149,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/60649510-4edb-4275-9339-181b451c603b" 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.7 → pywebexec-1.9.8}/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):

{pywebexec-1.9.7 → pywebexec-1.9.8}/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-1.9.7 → pywebexec-1.9.8}/pywebexec/swagger.yaml

@@ -190,7 +190,7 @@ paths:
             properties:
               message:
                 type: string
-  /executables:
+  /commands/exposed:
     get:
       summary: "List available executable commands"
       tags:
@@ -199,11 +199,11 @@ paths:
         - 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
@@ -214,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-1.9.7 → pywebexec-1.9.8}/pywebexec/version.py

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

{pywebexec-1.9.7 → pywebexec-1.9.8/pywebexec.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pywebexec
-Version: 1.9.7
+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/60649510-4edb-4275-9339-181b451c603b" 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        |
+