A framework for implementing Python services.
sphinx-apidoc?)pydoc?)This package is tested with the following Python minor versions:
This package is tested on the following platforms:
ubuntu-latestmacos-latestwindows-latest$ ./venv3.12/bin/runtimepy -h
usage: runtimepy [-h] [--version] [-v] [-q] [--curses] [--no-uvloop] [-C DIR]
{arbiter,mtu,server,task,tftp,tui,noop} ...
A framework for implementing Python services.
options:
-h, --help show this help message and exit
--version show program's version number and exit
-v, --verbose set to increase logging verbosity
-q, --quiet set to reduce output
--curses whether or not to use curses.wrapper when starting
--no-uvloop whether or not to disable uvloop as event loop driver
-C DIR, --dir DIR execute from a specific directory
commands:
{arbiter,mtu,server,task,tftp,tui,noop}
set of available commands
arbiter run a connection-arbiter application from a config
mtu probe for MTU size to some endpoint
server run a server for a specific connection factory
task run a task from a specific task factory
tftp perform a tftp interaction
tui run a terminal interface for the channel environment
noop command stub (does nothing)
arbiter$ ./venv3.12/bin/runtimepy arbiter -h
usage: runtimepy arbiter [-h] [-i] [-w] [--no-poller] configs [configs ...]
positional arguments:
configs the configuration to load
options:
-h, --help show this help message and exit
-i, --init_only, --init-only
exit after completing initialization
-w, --wait-for-stop, --wait_for_stop
ensure that a 'wait_for_stop' application method is
run last
--no-poller don't run a connection-metrics poller task
mtu$ ./venv3.12/bin/runtimepy mtu -h
usage: runtimepy mtu [-h] [--probe-size PROBE_SIZE] [--fallback FALLBACK] [-t]
destination [destination ...]
positional arguments:
destination endpoint parameters (host, port[, flowinfo, scope_id])
options:
-h, --help show this help message and exit
--probe-size PROBE_SIZE
data payload size to use for probe (default: 1432)
--fallback FALLBACK fallback MTU value if probing doesn't succeed (i.e.
not on Linux, default: 1500)
-t, --tcp use TCP instead of UDP
server$ ./venv3.12/bin/runtimepy server -h
usage: runtimepy server [-h] [-i] [-w] [--no-poller] [--cafile CAFILE]
[--capath CAPATH] [--cadata CADATA]
[--certfile CERTFILE] [--keyfile KEYFILE]
[--host HOST] [-p PORT] [-u] [-l]
factory [configs ...]
positional arguments:
factory name of connection factory to create server for
configs the configuration to load
options:
-h, --help show this help message and exit
-i, --init_only, --init-only
exit after completing initialization
-w, --wait-for-stop, --wait_for_stop
ensure that a 'wait_for_stop' application method is
run last
--no-poller don't run a connection-metrics poller task
--cafile CAFILE passed directly to instantiation
--capath CAPATH passed directly to instantiation
--cadata CADATA passed directly to instantiation
--certfile CERTFILE passed directly to instantiation
--keyfile KEYFILE passed directly to instantiation
--host HOST host address to listen on (default: '0.0.0.0')
-p PORT, --port PORT port to listen on (default: 0)
-u, --udp whether or not this is a UDP-based server (otherwise
it must be a TCP-based server)
-l, --loopback if true a client of the same connection type is added
task$ ./venv3.12/bin/runtimepy task -h
usage: runtimepy task [-h] [-i] [-w] [--no-poller] [-r RATE]
factory [configs ...]
positional arguments:
factory name of task factory to create task with
configs the configuration to load
options:
-h, --help show this help message and exit
-i, --init_only, --init-only
exit after completing initialization
-w, --wait-for-stop, --wait_for_stop
ensure that a 'wait_for_stop' application method is
run last
--no-poller don't run a connection-metrics poller task
-r RATE, --rate RATE rate (in Hz) that the task should run (default: 10)
tftp$ ./venv3.12/bin/runtimepy tftp -h
usage: runtimepy tftp [-h] [-p PORT] [-m MODE] [-t TIMEOUT] [-r REEMIT]
{read,write} host our_file [their_file]
positional arguments:
{read,write} action to perform
host host to message
our_file path to our file
their_file path to their file
options:
-h, --help show this help message and exit
-p PORT, --port PORT port to message (default: 69)
-m MODE, --mode MODE tftp mode to use (default: octet)
-t TIMEOUT, --timeout TIMEOUT
timeout for each step
-r REEMIT, --reemit REEMIT
transmit period for each step
tui$ ./venv3.12/bin/runtimepy tui -h
usage: runtimepy tui [-h] [-i ITERATIONS] [-r RATE]
options:
-h, --help show this help message and exit
-i ITERATIONS, --iterations ITERATIONS
maximum number of program iterations (if greater than
zero, default: 0)
-r RATE, --rate RATE frequency (in Hz) to run the interface (default: 60.0
Hz)
A coarse view of the internal structure and scale of
runtimepy's source.
Generated using pydeps (via
mk python-deps).
FAQs
A framework for implementing Python services.
We found that runtimepy demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.