Welcome to aqtinstall’s documentation!

Contents:

Command Line Options

The CLI uses argparse to parse the command line options so the short or long versions may be used and the long options may be truncated to the shortest unambiguous abbreviation.

list

list available versions (not implemented yet)

help

show generic help

install <Qt version> <target OS> <target variant> <target environment>

install Qt library specified version and target.

Qt version

This is a Qt version such as 5.9,7, 5.12.1 etc

target OS

linux, windows or mac

target variant

desktop or android

target environment
  • gcc_64 for linux desktop
  • clang_64 for mac desktip
  • win64_msvc2019_64, win64_msvc2017_64, win64_msvc2015_64, in32_msvc2015, win32_mingw53 for windows desktop
  • android_x86, android_armv7 for android
--version, -v

Display version

--help, -h

Display help text

--outputdir, -O <Output Directory>

specify output directory.

--base, -b <base url>

specify mirror site base url such as -b ‘http://mirrors.ocf.berkeley.edu/qt/’ where ‘online’ folder exist.

--modules, -m <list of modules>

specify extra modules to install as a list.

--archives <list of archives>

[Advanced] specify subset of archives to limit installed archvies.

src <Qt version> <target OS> <target variant>

install Qt sources specified version and target.

doc <Qt version> <target OS> <target variant>

install Qt documents specified version and target.

examples <Qt version> <target OS> <target variant>

install Qt examples specified version and target.

tools <target OS> <target tool name> <target tool version> <tool variant name>

install tools specified. tool name may be ‘tools_openssl_x64’, ‘tools_ninja’, ‘tools_ifw’, ‘tools_cmake’ and tool variants name may be ‘qt.tools.openssl.gcc_64’, ‘qt.tools.ninja’, ‘qt.tools.ifw.32’, ‘qt.tools.cmake’. You may need to looking for version number at https://download.qt.io/online/qtsdkrepository/

Internals

Archives module

Installer module

Cli module

Helper module

QtPatch module

aqtinstall changeLog

All notable changes to this project will be documented in this file.

Current changes

Unreleased

Added
Changed
Fixed
Deprecated
Removed
Security

v0.9.2 (19, June. 2020)

Added
  • Add Qt6 as a known version. (#144)
Fixed
  • Support package directory ‘qt6_*’ as well as ‘qt5_*’ (#145)

v0.9.1 (13, June. 2020)

Changed
  • Do not raise exception when specified combination is not found on downloaded meta data.
  • Update document for developers.

v0.9.0 (31, May. 2020)

Added
  • New subcommand doc/src/example to install each components.(#137, 138)
  • Doc: Add CLI example for tools, doc, examples and src.
Changed
  • Refactoring to reduce code duplication in archives.py
  • Explicitly call QtInstall.finalize() only when Qt library installation.
Fixed
  • Show help when launched without any argument (#136)

v0.9.0b3 (21, May. 2020)

Changed
  • Patch qmake when finishing installation.(#100) qmake has a hard-coded prefix path, and aqt modify binary in finish phase. it is not necessary for Qt 5.14.2, 5.15.0 and later. This behavior try to be as same as a Qt installer framework doing.
  • Patch Framework.QtCore when finishing installation.(#100) As same as qmake, framework also has a hard-coded prefix path. (Suggestions from @agateau)

v0.9.0b2 (21, May. 2020)

Added
  • CLI: ‘–archives’ option: it takes multiple module names such as qtbase, qtsvg etc. This is an advanced option to specify subset of target installation. There is no guarantee it works. It is not recommended if you are unknown what is doing.

v0.9.0b1 (10, May. 2020)

Added
  • Support installation of Qt version for msvc2019
  • Add knowlege of components combination on 5.14 and 5.15
Changed
  • Show detailed diagnose message when error happend.
  • CI test with Qt 5.14.2 and 5.15.0
  • CI test with installed mingw tools compiler.
  • Depends on py7zr v0.7.0b2 and later.
Fixed
  • Tools: Fix mingw installation failure.
  • Fix –outputdir behavior about path separator on windows

v0.8 (26, Mar. 2020)

Fixed
  • docs: fix broken link for qli-installer

v0.8b1 (12, Mar. 2020)

Added
  • Support specifing config with environment variable AQT_CONFIG
Fixed
  • Fix to use concurrency settings

v0.8a4 (6, Mar., 2020)

Fixed
  • Import-metadata package is required in python version < 3.8 not 3.7.
  • Refactoring redirect helper function to improve connection error checks and error message.(#109)

v0.8a3 (5, Mar., 2020)

Changed
  • Improve error messages when command argument is wrong.
Fixed

v0.8a1 (28, Feb., 2020)

Changed
  • Allow path search for 7z (#96)
  • Simplify multithreading using concurrent.futures.ThreadPoolExecutor().
Fixed
  • Detect exception on each download and extraction threads.
  • Race condition error happend on py7zr. require py7zr>=0.5.3.(#97)

v0.7.4 (15, Feb., 2020)

Changed
  • requirement of py7zr version become >0.6b2 which fixed a multiprocessing problem.

v0.7.3 (14, Feb., 2020)

Added
  • Github Actions workflows for publishing.
Changed
  • Remove run script from source. Now it is automatically generated when build.(#85)
  • Update requirement py7zr >=0.5
Fixed
  • README: fix reStructured text syntax.

v0.7.2 (11, Feb., 2020)

Changed
  • Replace ‘multiprocessing.dummy’ with ‘concurrent.futures’.
    • download with multi-threading(I/O bound)
    • extract with multi-processing(CPU bound)
Fixed
  • ‘-E | –external’ option handling which cause path is not str error.

v0.7.1 (13, Jan., 2020)

Fixed
  • Fix installation of extra modules for Qt5.9.

v0.7 (13, Jan., 2020)

Changed
  • Move project metadata to setup.cfg from setup.py.

v0.7b1 (10, Jan., 2020)

Changed
  • Bamp up dependency py7zr >=v0.5b5.
  • Use py7zr in default to extract packages.
  • Drop –internal command line option.

v0.7a2 (7, Jan., 2020)

Added
  • Add special module name ‘all’ for extra module option.
Fixed
  • CI conditions, update target version.

v0.7a1 (29, Nov., 2019)

Added
  • Introduce helper module.
  • Introduce ‘settings.ini’ file which has a configuration for aqt module.
Changed
  • Version numbering with setuptools_scm.
  • Now don’t install extra modules when installing ‘wasm_32’ arch. You should explicitly specify it with ‘-m’ option.
Fixed
  • Error when mirror site is not http, but https and ftp.

v0.6b1 (23, Nov., 2019)

Changed
  • Just warn when argument combination check is failed.
  • CI: Compress sample project for build test with 7zip.
  • CI: Place sample script in ci directory.

v0.6a2 (19, Nov., 2019)

Added
  • Test: Unit test against command line.
  • Android target variants.
Changed
  • Use logging configuration with logging.ini
Fixed
  • qconfig.pri: fix QT_LICHECK line.
Removed
  • Logging configuration file logging.yml
  • Drop dependency for pyyaml.

v0.6a1 (17, Nov., 2019)

Added
  • More build test with sample project which uses an extra module.(#56)
  • Add support for installation of WebAssembly component by specifying ‘wasm_32’ as an arch argument.(#53, #55)
Changed
  • Optional modules are installed explicitly. Users need to specify extra modules with -m option.(#52, #56)
Fixed
  • Dependency for py7zr only for python > 3.5. Now it works with python2.7.

v0.5 (10, Nov., 2019)

Changed
  • Introduce combination DB in json form. User and developer now easily add new component for installation checking.
Fixed
  • requires py7zr >= 0.4.1 because v0.4 can fails to extract file.

v0.5b2 (8, Oct., 2019)

Changed
  • Change install path from <target>/Qt/Qt<version>/<version> to <target>/<version> (#48). - Also update CI test to specify –outputdir <target> that is $(BinariesDirectory)/Qt

v0.5b1 (8, Oct., 2019)

Added
  • Add feature to support installation of Qt Tools
  • Add CI test for tool installation
Changed
  • CI test target - add 5.14.0 - remove 5.11.3 - change patch_levels to up-to-date

v0.4.3 (25, Sep, 2019)

Fixed
  • Allow multiple redirection to mirror site.(#41)

v0.4.2 (28, Jul, 2019)

Changed
  • README: update badge layout.
  • CI: Improve azure-pipelines configurations by Nelson (#20)
  • Check parameter combination allowance and add winrt variant.
  • Support installation of mingw runtime package.
  • Add ‘–internal’ option to use py7zr instead of external 7zip command for extracting package archives.(WIP)

v0.4.1 (01, Jun, 2019)

Added
  • Option -b | –base to specify mirror site.(#24)
Changed
  • CI: add script to generate auzre-pipelines.yml (#27, #28, #29)
  • CI: use powershell script for linux, mac and windows. (#26)
Fixed
  • Avoid blacklisted mirror site that cause CI fails.(#25)

v0.4.0 (29, May, 2019)

Added
  • cli: output directory option.
  • sphinx document.
  • test packaging on CI.
  • Handler for metalink information and intelligent mirror selection.
Changed
  • Change project directory structure.
  • cli command name changed from ‘aqtinst’ to ‘aqt’ and now you can run ‘aqt install’
  • Introduce Cli class
  • Massive regression test on azure pipelines(#20)
  • blacklist against http://mirrors.tuna.tsinghua.edu.cn and http://mirrors.geekpie.club/ from mirror site.
  • Run 7zip command with ‘-o{directory}’ option.
Fixed
  • Fix File Not Found Error when making qt.conf against win64_mingw73 and win32_mingw73

v0.3.1 (15, March, 2019)

Added
  • Qmake build test code in CI environment.(#14)
Fixed
  • Connect to Qt download server through proxy with authentication.(#17)
Changed
  • Change QtInstaller.install() function signature not to take any parameter.
  • Replace standard urllib to requests library.(#18)
  • Use 7zr external command instead of 7z in Linux and mac OSX envitonment.
Removed
  • requirements.txt file.

v0.3.0 (8, March, 2019)

Added
  • Allow execute both ‘aqtinst’ and ‘python -m aqt’ form.
Changed
  • Project URL is changed.
  • Generate universal wheel support both python2.7 and python 3.x.
Fixed
  • Update README wordings.
  • Remove dependency for python3 with ‘aqtinst’ command utility.
  • Fix command name in help message.

v0.2.0 (7, March, 2019)

Added
  • Released on pypi.org
Changed
  • Install not only basic packages also optional packages.
  • Rename project/command to aqt - Another QT installer
Fixed
  • Update mkspecs/qconfig.pri to indicate QT_EDITION is OpenSource
  • Support Python2

v0.1.0 (5, March, 2019)

Changed
  • Support multiprocess concurrent download and installation.

v0.0.2 (4, March, 2019)

Added

  • CI test on Azure-pipelines

Changed

  • Refactoring code
  • Install QtSDK into (cwd)/Qt<version>/<version>/gcc_64/
  • Drop dependency for requests library
  • Use standard argparse for command line argument.

Fixed

  • Support windows.
  • looking for 7zip in standard directory.

v0.0.1 (2, March, 2019)

  • Fork from qli-installer

Contribution guide

This is contribution guide for aqtinstall project. You are welcome to send a Pull-Request, reporting bugs and ask questions.

Resources

  • Project owner: Hiroshi Miura
  • Bug Tracker: Github issue Tracker
  • Status: alpha
  • Activity: high

Bug triage

Every report to github issue tracker should be in triage. whether it is bug, question or invalid.

Send patch

Here is small amount rule when you want to send patch the project;

  1. every proposal for modification should send as ‘Pull Request’
  1. each pull request can consist of multiple commits.
  1. you are encourage to split modifications to individual commits that are logical subpart.

CI tests

The project configured to use Azure Pipelines, Travis-CI and CoverAlls for regression test. You can see test results on badge and see details in a web page linked from badge.

Authors

Aqtinstall is written and maintained by Hiroshi Miura <miurahr@linux.com>

Original qli-installer is written by Linus Jahn

Contributors, listed alphabetically, are:

  • Kyle Altendorf (7z binary path search)
  • Martin Delille
  • Nelson Chen (CI tests)
  • Skycoder42 (Explicit extra module installation)
  • Thomas Grainger

Indices and tables