pyside6-project

pyside6-project is a command line tool for creating, building and deploying Qt for Python applications. It operates on a project file which is also used by Qt Creator.

Project file format

The project file format is a simple JSON-based format with the suffix .pyproject listing all files of the project excluding generated files (typically .py, .qml, .qrc, .ts, or .ui files):

{
    "files": ["main.py"]
}

Usage

The tool has several subcommands. New projects can be created using the below commands, passing the project name (directory):

new-ui

Creates a new QtWidgets project with a Qt Widgets Designer-based main window.

new-widget

Creates a new QtWidgets project with a main window.

new-quick

Creates a new QtQuick project.

The other commands take the project file as an argument. It is also possible to specify a directory containing the project file.

build

Builds the project, generating the required build artifacts (see using_ui_files, using_qrc_files).

run

Builds the project and runs the main.

deploy

Deploys the application (see see pyside6-deploy: the deployment tool for Qt for Python).

lupdate

Updates translation (.ts) files (see translations).

clean

Cleans the build artifacts.

qmllint

Runs the qmllint tool, checking the QML files.