pywebexec 1.2.4__tar.gz

pywebexec-1.2.4/.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

pywebexec-1.2.4/.gitignore

@@ -0,0 +1,172 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc
+pywebexec/version.py

pywebexec-1.2.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 joknarf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pywebexec-1.2.4/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.2
+Name: pywebexec
+Version: 1.2.4
+Summary: Simple Python HTTP Exec Server
+Home-page: https://github.com/joknarf/pywebexec
+Author: Franck Jouvanceau
+Maintainer: Franck Jouvanceau
+License: MIT License
+        
+        Copyright (c) 2025 joknarf
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/joknarf/pywebexec
+Project-URL: Documentation, https://github.com/joknarf/pywebexec/blob/main/README.md
+Project-URL: Repository, https://github.com/joknarf/pywebexec.git
+Keywords: http,server,remote commands,api,website
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Operating System :: Microsoft :: Windows 
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Clustering
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-daemon>=2.3.2
+Requires-Dist: cryptography>=40.0.2
+Requires-Dist: Flask>=2.0.3
+Requires-Dist: Flask-HTTPAuth>=4.8.0
+Requires-Dist: gunicorn>=21.2.0
+Requires-Dist: ldap3>=2.9.1
+
+[![Pypi version](https://img.shields.io/pypi/v/pywebexec.svg)](https://pypi.org/project/pywebexec/)
+![example](https://github.com/joknarf/pywebexec/actions/workflows/python-publish.yml/badge.svg)
+[![Licence](https://img.shields.io/badge/licence-MIT-blue.svg)](https://shields.io/)
+[![PyPI Downloads](https://static.pepy.tech/badge/pywebexec)](https://pepy.tech/projects/pywebexec)
+[![Python versions](https://img.shields.io/badge/python-3.6+-blue.svg)](https://shields.io/)
+
+# pywebexec
+Simple Python HTTP(S) API/Web Command Launcher
+
+## Install
+```
+$ pip install pywebexec
+```
+
+## Quick start
+
+* put in a directory the scripts/commands/links to commands you want to expose
+* start http server serving current directory executables listening on 0.0.0.0 port 8080
+```shell
+$ pywebexec
+```
+
+* Launch commands with params/view live output/Status using browser
+![pywebexecnew4](https://github.com/user-attachments/assets/55e9058c-d2d9-470e-b3ea-60b10dfc7fce)
+
+all commands output / statuses are available in the executables directory in subdirectory `.web_status`
+
+## features
+
+* Serve executables in a directory
+* Launch commands with params from web browser or API call
+* Follow live output
+* Stop command
+* Relaunch command
+* HTTPS support
+* HTTPS self-signed certificate generator
+* Basic Auth
+* LDAP(S)
+* Can be started as a daemon (POSIX)
+* Uses gunicorn to serve http/https
+* Linux/MacOS compatible
+
+## Customize server
+```shell
+$ pywebexec --dir ~/myscripts --listen 0.0.0.0 --port 8080 --title myscripts
+$ pywebexec -d ~/myscripts -l 0.0.0.0 -p 8080 -t myscripts
+```
+
+## Basic auth 
+
+* single user/password
+```shell
+$ pywebexec --user myuser [--password mypass]
+$ pywebexec -u myuser [-P mypass]
+```
+Generated password is given if no `--pasword` option
+
+* ldap(s) password check / group member
+```shell
+$ export PYWEBEXEC_LDAP_SERVER=ldap://ldap.forumsys.com:389
+$ export PYWEBEXEC_LDAP_BIND_DN="cn=read-only-admin,dc=example,dc=com"
+$ export PYWEBEXEC_LDAP_BIND_PASSWORD="password"
+$ export PYWEBEXEC_LDAP_GROUPS="ou=mathematicians,ou=scientists"
+$ export PYWEBEXEC_LDAP_USER_ID="uid"
+$ export PYWEBEXEC_LDAP_BASE_DN="dc=example,dc=com"
+$ pywebexec
+```
+## HTTPS server
+
+* Generate auto-signed certificate and start https server
+```shell
+$ pywebexec --gencert
+$ pywebexec --g
+```
+
+* Start https server using existing certificate
+```shell
+$ pywebexec --cert /pathto/host.cert --key /pathto/host.key
+$ pywebexec -c /pathto/host.cert -k /pathto/host.key
+```
+
+## Launch server as a daemon
+
+```shell
+$ pywebexec start
+$ pywebexec status
+$ pywebexec stop
+```
+* log of server are stored in directory `~/[.config/].pywebexec/pywebexec_<listen>:<port>.log`
+
+## Launch command through API
+
+```shell
+$ curl http://myhost:8080/run_command -H 'Content-Type: application/json' -X POST -d '{ "command":"myscript", "params":["param1", ...]}'
+$ curl http://myhost:8080/command_status/<command_id>
+$ curl http://myhost:8080/command_output/<command_id> -H "Accept: text/plain"
+```
+
+## API reference
+
+
+| method    | route                       | params/payload     | returns
+|-----------|-----------------------------|--------------------|---------------------|
+| POST      | /run_command                | command: str<br>params: array[str]       | command_id: uuid<br>message: str    |
+| POST      | /stop_command/command_id    |                    | message: str        |
+| GET       | /command_status/command_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       | /command_output/command_id  | offset: int        | output: str<br>status: str<br>links: { next: str }         |
+| GET       | /commands                   |                    | array of<br>command_id: uuid<br>command: str<br>start_time: isotime<br>end_time: isotime<br>status: str<br>exit_code: int<br>last_output_line: str      |
+| GET       | /executables                |                    | array of str        |

pywebexec-1.2.4/README.md

@@ -0,0 +1,109 @@
+[![Pypi version](https://img.shields.io/pypi/v/pywebexec.svg)](https://pypi.org/project/pywebexec/)
+![example](https://github.com/joknarf/pywebexec/actions/workflows/python-publish.yml/badge.svg)
+[![Licence](https://img.shields.io/badge/licence-MIT-blue.svg)](https://shields.io/)
+[![PyPI Downloads](https://static.pepy.tech/badge/pywebexec)](https://pepy.tech/projects/pywebexec)
+[![Python versions](https://img.shields.io/badge/python-3.6+-blue.svg)](https://shields.io/)
+
+# pywebexec
+Simple Python HTTP(S) API/Web Command Launcher
+
+## Install
+```
+$ pip install pywebexec
+```
+
+## Quick start
+
+* put in a directory the scripts/commands/links to commands you want to expose
+* start http server serving current directory executables listening on 0.0.0.0 port 8080
+```shell
+$ pywebexec
+```
+
+* Launch commands with params/view live output/Status using browser
+![pywebexecnew4](https://github.com/user-attachments/assets/55e9058c-d2d9-470e-b3ea-60b10dfc7fce)
+
+all commands output / statuses are available in the executables directory in subdirectory `.web_status`
+
+## features
+
+* Serve executables in a directory
+* Launch commands with params from web browser or API call
+* Follow live output
+* Stop command
+* Relaunch command
+* HTTPS support
+* HTTPS self-signed certificate generator
+* Basic Auth
+* LDAP(S)
+* Can be started as a daemon (POSIX)
+* Uses gunicorn to serve http/https
+* Linux/MacOS compatible
+
+## Customize server
+```shell
+$ pywebexec --dir ~/myscripts --listen 0.0.0.0 --port 8080 --title myscripts
+$ pywebexec -d ~/myscripts -l 0.0.0.0 -p 8080 -t myscripts
+```
+
+## Basic auth 
+
+* single user/password
+```shell
+$ pywebexec --user myuser [--password mypass]
+$ pywebexec -u myuser [-P mypass]
+```
+Generated password is given if no `--pasword` option
+
+* ldap(s) password check / group member
+```shell
+$ export PYWEBEXEC_LDAP_SERVER=ldap://ldap.forumsys.com:389
+$ export PYWEBEXEC_LDAP_BIND_DN="cn=read-only-admin,dc=example,dc=com"
+$ export PYWEBEXEC_LDAP_BIND_PASSWORD="password"
+$ export PYWEBEXEC_LDAP_GROUPS="ou=mathematicians,ou=scientists"
+$ export PYWEBEXEC_LDAP_USER_ID="uid"
+$ export PYWEBEXEC_LDAP_BASE_DN="dc=example,dc=com"
+$ pywebexec
+```
+## HTTPS server
+
+* Generate auto-signed certificate and start https server
+```shell
+$ pywebexec --gencert
+$ pywebexec --g
+```
+
+* Start https server using existing certificate
+```shell
+$ pywebexec --cert /pathto/host.cert --key /pathto/host.key
+$ pywebexec -c /pathto/host.cert -k /pathto/host.key
+```
+
+## Launch server as a daemon
+
+```shell
+$ pywebexec start
+$ pywebexec status
+$ pywebexec stop
+```
+* log of server are stored in directory `~/[.config/].pywebexec/pywebexec_<listen>:<port>.log`
+
+## Launch command through API
+
+```shell
+$ curl http://myhost:8080/run_command -H 'Content-Type: application/json' -X POST -d '{ "command":"myscript", "params":["param1", ...]}'
+$ curl http://myhost:8080/command_status/<command_id>
+$ curl http://myhost:8080/command_output/<command_id> -H "Accept: text/plain"
+```
+
+## API reference
+
+
+| method    | route                       | params/payload     | returns
+|-----------|-----------------------------|--------------------|---------------------|
+| POST      | /run_command                | command: str<br>params: array[str]       | command_id: uuid<br>message: str    |
+| POST      | /stop_command/command_id    |                    | message: str        |
+| GET       | /command_status/command_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       | /command_output/command_id  | offset: int        | output: str<br>status: str<br>links: { next: str }         |
+| GET       | /commands                   |                    | array of<br>command_id: uuid<br>command: str<br>start_time: isotime<br>end_time: isotime<br>status: str<br>exit_code: int<br>last_output_line: str      |
+| GET       | /executables                |                    | array of str        |

pywebexec-1.2.4/pyproject.toml

@@ -0,0 +1,59 @@
+[project]
+name = "pywebexec"
+authors = [
+    { name = "Franck Jouvanceau" },
+]
+maintainers = [
+    { name = "Franck Jouvanceau" },
+]
+
+description = "Simple Python HTTP Exec Server"
+dependencies = [
+  "python-daemon>=2.3.2",
+  "cryptography>=40.0.2",
+  "Flask>=2.0.3",
+  "Flask-HTTPAuth>=4.8.0",
+  "gunicorn>=21.2.0",
+  "ldap3>=2.9.1",
+]
+dynamic=["version"]
+readme = "README.md"
+license = {file = "LICENSE"}
+requires-python = ">= 3.6"
+keywords = ["http", "server", "remote commands", "api", "website"]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Intended Audience :: System Administrators",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: POSIX",
+  "Operating System :: Unix",
+  "Operating System :: Microsoft :: Windows ",
+  "Operating System :: MacOS",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.6",
+  "Programming Language :: Python :: 3.7",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: System :: Clustering",
+  "Topic :: System :: Networking",
+  "Topic :: System :: Systems Administration",
+]
+
+[project.urls]
+Homepage = "https://github.com/joknarf/pywebexec"
+Documentation = "https://github.com/joknarf/pywebexec/blob/main/README.md"
+Repository = "https://github.com/joknarf/pywebexec.git"
+
+[build-system]
+requires = ["setuptools >= 61.0", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+version_file = "pywebexec/version.py"
+
+[project.scripts]
+pywebexec = "pywebexec.pywebexec:main"

pywebexec-1.2.4/pywebexec/__init__.py

@@ -0,0 +1,5 @@
+""" package pywebexec """
+
+__author__ = "Franck Jouvanceau"
+
+from .pywebexec import start_gunicorn