diff options
Diffstat (limited to 'sources/pyside6/doc/building_from_source')
| -rw-r--r-- | sources/pyside6/doc/building_from_source/linux.rst | 18 | ||||
| -rw-r--r-- | sources/pyside6/doc/building_from_source/macOS.rst | 24 | ||||
| -rw-r--r-- | sources/pyside6/doc/building_from_source/windows.rst | 24 |
3 files changed, 66 insertions, 0 deletions
diff --git a/sources/pyside6/doc/building_from_source/linux.rst b/sources/pyside6/doc/building_from_source/linux.rst index 5dec758b6..49d3dc9d8 100644 --- a/sources/pyside6/doc/building_from_source/linux.rst +++ b/sources/pyside6/doc/building_from_source/linux.rst @@ -25,6 +25,17 @@ which arbitrary modules can be installed and which can be removed after use:: will create and use a new virtual environment, which is indicated by the command prompt changing. +Alternatively, you can use the `uv`_ tool, which is popular in the Python community for Python +project management. The following command creates a virtual environment using `uv`_:: + + uv venv --python <python-version> testenv + source testenv/bin/activate + +.. note:: Since the Qt for Python project still uses `setup.py` and not `pyproject.toml`, currently + `uv` can only be used as a replacement for `pyenv` for building Qt for Python. If you + have already the `.python_version` file(used by .pyenv) in the project, make sure to + change the version to the `uv`_ Python you want to use. + Setting up CLANG ~~~~~~~~~~~~~~~~ @@ -61,6 +72,8 @@ For building the documentation:: Additionally, :command:`git checkout -b 6.8 --track origin/6.8` could be a better option in case you want to work on it. +.. note:: With `uv`_, use `uv pip install ...` + Building and Installing (setuptools) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -78,6 +91,10 @@ To install on the current directory, just run:: python setup.py install --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 +With `uv`_, these commands becomes:: + + uv run setup.py build/install --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 + Building and Installing (cmake) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -117,3 +134,4 @@ Remember to properly set the environment variables for Qt and PySide:: python examples/widgets/widgets/tetrix/tetrix.py .. _`Qt for Linux/X11`: https://doc.qt.io/qt-6/linux.html +.. _`uv`: https://docs.astral.sh/uv/ diff --git a/sources/pyside6/doc/building_from_source/macOS.rst b/sources/pyside6/doc/building_from_source/macOS.rst index 267572444..bb6a0dd2b 100644 --- a/sources/pyside6/doc/building_from_source/macOS.rst +++ b/sources/pyside6/doc/building_from_source/macOS.rst @@ -29,6 +29,17 @@ which arbitrary modules can be installed and which can be removed after use:: will create and use a new virtual environment, which is indicated by the command prompt changing. +Alternatively, you can use the `uv`_ tool, which is popular in the Python community for Python +project management. The following command creates a virtual environment using `uv`_:: + + uv venv --python <python-version> testenv + source testenv/bin/activate + +.. note:: Since the Qt for Python project still uses `setup.py` and not `pyproject.toml`, currently + `uv` can only be used as a replacement for `pyenv` for building Qt for Python. If you + have already the `.python_version` file(used by .pyenv) in the project, make sure to + change the version to the `uv`_ Python you want to use. + Setting up CLANG ~~~~~~~~~~~~~~~~ @@ -63,6 +74,8 @@ For building the documentation:: .. note:: Keep in mind you need to use the same version as your Qt installation +.. note:: With `uv`_, use `uv pip install ... + Building PySide ~~~~~~~~~~~~~~~ @@ -73,6 +86,11 @@ Build can take a few minutes, so it is recommended to use more than one CPU core python setup.py build --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 +With `uv`_, this commands becomes:: + + uv run setup.py build --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 + + Installing PySide ~~~~~~~~~~~~~~~~~ @@ -80,6 +98,10 @@ To install on the current directory, just run:: python setup.py install --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 +With `uv`_, this commands becomes:: + + uv run setup.py install --qtpaths=/opt/Qt/6.8.0/gcc_64/bin/qtpaths --build-tests --ignore-git --parallel=8 + Test installation ~~~~~~~~~~~~~~~~~ @@ -87,3 +109,5 @@ You can execute one of the examples to verify the process is properly working. Remember to properly set the environment variables for Qt and PySide:: python examples/widgets/widgets/tetrix/tetrix.py + +.. _`uv`: https://docs.astral.sh/uv/ diff --git a/sources/pyside6/doc/building_from_source/windows.rst b/sources/pyside6/doc/building_from_source/windows.rst index 34b98e8f8..170a8e6a2 100644 --- a/sources/pyside6/doc/building_from_source/windows.rst +++ b/sources/pyside6/doc/building_from_source/windows.rst @@ -33,6 +33,17 @@ which arbitrary modules can be installed and which can be removed after use:: will create and use a new virtual environment, which is indicated by the command prompt changing. +Alternatively, you can use the `uv`_ tool, which is popular in the Python community for Python +project management. The following command creates a virtual environment using `uv`_:: + + uv venv --python <python-version> testenv + call testenv\Scripts\activate + +.. note:: Since the Qt for Python project still uses `setup.py` and not `pyproject.toml`, currently + `uv` can only be used as a replacement for `pyenv` for building Qt for Python. If you + have already the `.python_version` file(used by .pyenv) in the project, make sure to + change the version to the `uv`_ Python you want to use. + Setting up CLANG ~~~~~~~~~~~~~~~~ @@ -71,6 +82,8 @@ For building the documentation:: .. note:: Keep in mind you need to use the same version as your Qt installation +.. note:: With `uv`_, use `uv pip install ...` + Building PySide ~~~~~~~~~~~~~~~ @@ -81,6 +94,11 @@ Build can take a few minutes, so it is recommended to use more than one CPU core python setup.py build --qtpaths=c:\path\to\qtpaths.exe --openssl=c:\path\to\openssl\bin --build-tests --ignore-git --parallel=8 +With `uv`_, this commands becomes:: + + uv run setup.py build --qtpaths=c:\path\to\qtpaths.exe --openssl=c:\path\to\openssl\bin --build-tests --ignore-git --parallel=8 + + .. _creating_windows_debug_builds: Creating Debug Builds @@ -105,6 +123,10 @@ To install on the current directory, just run:: python setup.py install --qtpaths=c:\path\to\qtpaths.exe --openssl=c:\path\to\openssl\bin --build-tests --ignore-git --parallel=8 +With `uv`_, this command becomes:: + + uv run setup.py install --qtpaths=c:\path\to\qtpaths.exe --openssl=c:\path\to\openssl\bin --build-tests --ignore-git --parallel=8 + Test installation ~~~~~~~~~~~~~~~~~ @@ -112,3 +134,5 @@ You can execute one of the examples to verify the process is properly working. Remember to properly set the environment variables for Qt and PySide:: python examples/widgets/widgets/tetrix/tetrix.py + +.. _`uv`: https://docs.astral.sh/uv/ |
