Pyclientutils

OsProject

OsProject
edit
id	pyclientutils
state	active
owner	WolfgangFahl
title	pyclientutils
url	https://github.com/WolfgangFahl/pyclientutils
version	0.0.4
description	python MediaWiki client utilities
date	2026-01-29
since	2026-01-28
until

Installation

pip install pyclientutils
# alternatively if your pip is not a python3 pip
pip3 install pyclientutils 
# local install from source directory of pyclientutils 
pip install .

upgrade

pip install pyclientutils  -U
# alternatively if your pip is not a python3 pip
pip3 install pyclientutils -U

Usage

clientutils -h
usage: clientutils [-h] [-a] [-d] [--debugLocalPath DEBUGLOCALPATH]
                   [--debugPort DEBUGPORT] [--debugRemotePath DEBUGREMOTEPATH]
                   [--debugServer DEBUGSERVER] [-f] [-q] [-v] [-V] [--start]
                   [--host HOST] [--port PORT] [--no-file-access]
                   [--icons-dir ICONS_DIR]
                   [--external-base-url EXTERNAL_BASE_URL]
                   [--log-level {critical,error,warning,info,debug,trace}]
                   [--path-mapping PATH_MAPPING_YAML_PATH]

MediaWiki Client Utilties

options:
  -h, --help            show this help message and exit
  -a, --about           show version info and open documentation
  -d, --debug           enable debug output
  --debugLocalPath DEBUGLOCALPATH
                        remote debug Server path mapping - localPath - path on
                        machine where python runs
  --debugPort DEBUGPORT
                        remote debug Port [default: 5678]
  --debugRemotePath DEBUGREMOTEPATH
                        remote debug Server path mapping - remotePath - path
                        on debug server
  --debugServer DEBUGSERVER
                        remote debug Server
  -f, --force           force overwrite or unsafe actions
  -q, --quiet           suppress all output
  -v, --verbose         increase output verbosity
  -V, --version         show program's version number and exit
  --start               start the webserver
  --host HOST           host to bind (default: 0.0.0.0)
  --port PORT           port for the webserver (default: 9998)
  --no-file-access      disable file access routes
  --icons-dir ICONS_DIR
                        path to icons directory
  --external-base-url EXTERNAL_BASE_URL
                        external base URL used by file routes (e.g.
                        https://clientutils.example.com/)
  --log-level {critical,error,warning,info,debug,trace}
                        uvicorn log level
  --path-mapping PATH_MAPPING_YAML_PATH
                        path to YAML path mapping configuration file (e.g.
                        config/path_mappings.yaml)