quarchpy.qps package

Submodules

quarchpy.qps.qpsFuncs module

quarchpy.qps.qpsFuncs.GetQpsModuleSelection(QpsConnection: QpsInterface, favouriteOnly=True, additionalOptions=['rescan', 'all con types', 'ip scan'], scan=True)

Deprecated: use QpsInterface.get_module_selection instead. This function will return a module selection list from QPS.

quarchpy.qps.qpsFuncs.closeQps(host='127.0.0.1', port=9822)

quarchpy.qps.qpsFuncs.isQpsRunning(host='127.0.0.1', port=9822, timeout=0)

This func will return true if QPS is running with a working QIS connection.

quarchpy.qps.qpsFuncs.reader(stream, q, source, lock, stop_flag)

Used to read output and place it in a queue for multithreaded reading :param stream: :param q: :param source: :param lock: The lock for the queue :param stop_flag: Flag to exit the loop and close the thread :return: None

quarchpy.qps.qpsFuncs.startLocalQps(keepQisRunning: bool = False, args: List[str] | None = [], timeout: int = 30, startQPSMinimised: bool = True, host: str = '127.0.0.1', port: int = 9822, qis_port: int = 9722, qis_rest_port: int = 9780) → QpsInterface | None

Main entry point to start a local QPS instance.

Module contents

quarchpy.qps.GetQpsModuleSelection(QpsConnection: QpsInterface, favouriteOnly=True, additionalOptions=['rescan', 'all con types', 'ip scan'], scan=True)

Deprecated: use QpsInterface.get_module_selection instead. This function will return a module selection list from QPS.

quarchpy.qps.closeQps(host='127.0.0.1', port=9822)

quarchpy.qps.isQpsRunning(host='127.0.0.1', port=9822, timeout=0)

This func will return true if QPS is running with a working QIS connection.

quarchpy.qps.qpsInterface

alias of QpsInterface

quarchpy.qps.startLocalQps(keepQisRunning: bool = False, args: List[str] | None = [], timeout: int = 30, startQPSMinimised: bool = True, host: str = '127.0.0.1', port: int = 9822, qis_port: int = 9722, qis_rest_port: int = 9780) → QpsInterface | None

Main entry point to start a local QPS instance.