Joerg Bornemann 268767e9a1 pro2cmake: Update README.md

Mention that flake8 and black can be run via Makefile targets.

Remove the outdated list of flake8 warnings.  The Makefile ignores more
warnings/errors, and it doesn't seem to be useful to duplicate this list
here.

Also remove the description of the black tool's arguments for the same
reason.

Change-Id: I941c3ab68b7a3d2477f7fbb5d28603987d0b2cab
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>

2022-02-28 15:41:22 +01:00

1.5 KiB

Raw Blame History

CMake Utils

This directory holds scripts to help the porting process from qmake to cmake for Qt6.

Requirements

Python 3.7,
pipenv or pip to manage the modules.

Python modules

Since Python has many ways of handling projects, you have a couple of options to install the dependencies of the scripts:

Using `pipenv`

The dependencies are specified on the Pipfile, so you just need to run pipenv install and that will automatically create a virtual environment that you can activate with a pipenv shell.

Using `pip`

It's highly recommended to use a virtualenvironment to avoid conflict with other packages that are already installed: pip install virtualenv.

Create an environment: virtualenv env,
Activate the environment: source env/bin/activate (on Windows: source env\Scripts\activate.bat)
Install the requirements: pip install -r requirements.txt

If the pip install command above doesn't work, try:

python3.7 -m pip install -r requirements.txt

Contributing to the scripts

You can verify if the styling of a script is compliant with PEP8, with a couple of exceptions:

Install flake8 (pip install flake8) and run it on all python source files:

make flake8

You can also modify the file with an automatic formatter, like black (pip install black), and execute it:

make format

1.5 KiB Raw Blame History