edq.cli

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:


edq.cli.config.*

The edq.cli.config package provides tools for working with project configuration options.


edq.cli.config.list

List the current configuration options.

usage: python3 -m edq.cli.config.list [-h] [--show-origin] [--skip-header]

edq.cli.doc.*

The edq.cli.doc package provides tools for working with documentation.


edq.cli.doc.update-pdoc-cli

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

edq.cli.http.*

The edq.cli.http package contains tools for working with HTTP/web resources.


edq.cli.http.exchange-server

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 ...]

edq.cli.http.send-exchange

Send an HTTP exchange to the target server.

usage: python3 -m edq.cli.http.send-exchange [-h] SERVER PATH

edq.cli.http.verify-exchanges

Verify that exchanges sent to a given server have the same response.

usage: python3 -m edq.cli.http.verify-exchanges [-h] SERVER PATH [PATH ...]

edq.cli.testing.*

The edq.cli.testing package provides testing-related utilities.


edq.cli.testing.cli-test

Run specified CLI test files.

usage: python3 -m edq.cli.testing.cli-test [-h] [--data-dir DATA_DIR]
                                           PATH [PATH ...]

edq.cli.version

Get the version of the EduLinq Python utils package.

usage: python3 -m edq.cli.version [-h]
1"""
2The edq.cli package contains general tools for the EduLinq Python library.
3Each package can be invoked to list the tools (or subpackages) it contains.
4Each tool includes a help prompt that accessed with the `-h`/`--help` flag.
5"""