edq
The edq.cli package contains general tools for the EduLinq Python library.
Each package can be invoked to list the tools (or subpackages) it contains.
Each tool includes a help prompt that accessed with the -h/--help flag.
This package contains the following CLI tools:
This package provides tools for working with project configuration options.
Encrypt any unencrypted secrets present in configuration files.
usage: python3 -m edq.cli.config.encrypt [-h] [--dry-run] [PATHS ...]
List the current configuration options.
usage: python3 -m edq.cli.config.list [-h] [--include-cli] [--show-origin]
[--skip-header]
Update configuration options. The file at the specified config location will be created if it doesn't exist.
usage: python3 -m edq.cli.config.set [-h]
[--local | --project | --global | --file ]
= [= ...]
Unset the first matching instance of a configuration option. Does nothing if there is no matching config.
usage: python3 -m edq.cli.config.unset [-h]
[--local | --project | --global | --file ]
KEY [KEY ...]
The edq.cli.crypto package contains cryptographic tools.
Decrypt an edq.util.crypto.Secret into cleartext. The standard configuration encryption key will be used.
usage: python3 -m edq.cli.crypto.decrypt-secret [-h] TEXT
Encrypt a cleartext string as an edq.util.crypto.Secret. The standard configuration encryption key will be used.
usage: python3 -m edq.cli.crypto.encrypt-secret [-h]
[--encryption-method {AES256v1}]
[--salt SALT] [--iv IV]
TEXT
The edq.cli.doc package provides tools for working with documentation.
Insert CLI documentation into built pdoc HTML documentation.
usage: python3 -m edq.cli.doc.update-pdoc-cli [-h]
PYTHON_PACKAGE
PYTHON_QUALIFIED_NAME
HTML_DOCS_DIR
The edq.cli.http package contains tools for working with HTTP/web resources.
Start an HTTP test server that serves the specified HTTP exchanges.
usage: python3 -m edq.cli.http.exchange-server [-h] [--port PORT]
[--ignore-param IGNORE_PARAMS]
[--ignore-header IGNORE_HEADERS]
PATH [PATH ...]
Send an HTTP exchange to the target server.
usage: python3 -m edq.cli.http.send-exchange [-h] SERVER PATH
Verify that exchanges sent to a given server have the same response.
usage: python3 -m edq.cli.http.verify-exchanges [-h] SERVER PATH [PATH ...]
The edq.cli.profile package contains Python profiling tools.
Profile some Python target using Python's cprofile stdlib.
usage: python3 -m edq.cli.profile.cprofile [-h] [--module] [--count ROW_COUNT]
[--import IMPORTS]
[--pattern PATTERNS]
RUN_TARGET [MODULE_ARGS ...]
Profile some Python target using Python's cprofile stdlib.
usage: python3 -m edq.cli.profile.flame [-h] [--module] [--import IMPORTS]
[--out OUT_PATH]
[--flamegraph-path FLAMEGRAPH_PATH]
[--sample-interval SAMPLE_INTERVAL_SECS]
RUN_TARGET [MODULE_ARGS ...]
The edq.cli.testing package provides testing-related utilities.
Run specified CLI test files.
usage: python3 -m edq.cli.testing.cli-test [-h] [--data-dir DATA_DIR]
PATH [PATH ...]
Get the version of the EduLinq Python utils package.
usage: python3 -m edq.cli.version [-h]