Name | qtutils JSON |
Version |
4.0.0
JSON |
| download |
home_page | None |
Summary | PySide6/PyQt5 abstraction layer, mulithreading and UI loader utilities, icon set, and more |
upload_time | 2024-12-17 01:36:15 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.8 |
license | Copyright (c) 2013, Christopher Billington, Philip Starkey All rights reserved. This project (qtutils) is dual licensed under the 2-clause BSD license and 3-clause BSD license (see the files BSD-2-CLAUSE-LICENSE.txt and BSD-3-CLAUSE-LICENSE.txt), subject to the following conditions: 1) If you wish to use this project with PySide and/or a commercial license of PyQt, the use of this project is governed by the terms of one of the licenses, chosen at your discretion. 2) If you wish to use this project with the free (GPLv2 or GPLv3 licensed) version of PyQt, the use of this project is governed by the terms of the 3-clause BSD license only, along with the terms specified in the GPL_EXCEPTIONS.TXT file in the PyQt project source code. These terms are in place to guarantee compatibility with the terms outlined in the GPL License Exceptions of the PyQt project (see the GPL_EXCEPTIONS.TXT file in the source code of the PyQt project) This project includes the Fugue icon set by Yusuke Kamiyamane, licensed under a Creative Commons Attribution 3.0 License. See icons/LICENSE.txt. This project includes the Ubuntu Mono font by Canonical, licensed under the Ubuntu Font License 1.0, see: https://ubuntu.com/legal/font-licence |
keywords |
qt
pyqt
pyside
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# qtutils
[![Actions Status](https://github.com/philipstarkey/qtutils/workflows/Build%20and%20Release/badge.svg)](https://github.com/philipstarkey/qtutils/actions)
![GitHub release](https://img.shields.io/github/last-commit/philipstarkey/qtutils.svg)
[![Python Version](https://img.shields.io/pypi/pyversions/qtutils.svg)](https://python.org)
[![Documentation Status](https://readthedocs.org/projects/qtutils/badge/?version=stable)](https://qtutils.readthedocs.io/en/stable/?badge=stable)
[![PyPi Version](https://img.shields.io/pypi/v/qtutils.svg)](https://pypi.python.org/pypi/qtutils/)
[![Conda Version](https://img.shields.io/conda/v/labscript-suite/qtutils)](https://anaconda.org/labscript-suite/qtutils)
[![PyPi License](https://img.shields.io/pypi/l/qtutils.svg)](https://github.com/philipstarkey/qtutils/blob/master/LICENSE.txt)
Utilities for providing concurrent access to Qt objects, simplified QSettings storage,
and dynamic widget promotion when loading UI files, in Python Qt applications. Includes
the Fugue icon set, free to use with attribution to Yusuke Kamiyamane, and the Ubuntu
font family (available under the [Ubuntu font
license](https://ubuntu.com/legal/font-licence)).
* [Documentation](https://qtutils.readthedocs.io)
* [PyPI](https://pypi.python.org/pypi/qtutils/)
* [Source code (GitHub)](https://github.com/philipstarkey/qtutils)
## Installation
* To install the latest release version, run `pip install qtutils`.
* To install latest development version, clone the GitHub repository and run `pip
install .` to install, or `pip install -e .` to install in 'editable' mode.
## Summary
`qtutils` is a Python library that provides some convenient features to Python
applications using the PyQt5/PySide6 widget library.
`qtutils` 4.0 dropped support for PySide2. If you need to use PySide2, you may use
`qtutils` 3.1.0 or earlier.
`qtutils` contains the following components:
* `invoke_in_main`: This provides some helper functions to interact with Qt from
threads.
* `UiLoader`: This provides a simplified means of promoting widgets in `*.ui` files to a
custom widget of your choice.
* `qsettings_wrapper`: A wrapper around QSettings which allows you to access keys of
QSettings as instance attributes. It also performs automatic type conversions.
* `icons`: An icon set as a `QResource` file and corresponding Python module. The
resulting resource file can be used by Qt designer, and the python module imported by
applications to make the icons available to them. The Fugue icon set was made by
Yusuke Kamiyamane, and is licensed under a Creative Commons Attribution 3.0 License.
If you can't or don't want to provide attribution, please purchase a royalty-free
license from http://p.yusukekamiyamane.com/
* `Qt`: a PyQt5/PySide6 agnostic interface to Qt that allows you to import qtutils.qt
instead of PySide6 or PyQt5, and have your code run on both, with some convenience
aliases to make it easier to write code that works with both libraries. Note that this
is not a comprehensive abstraction layer like [QtPy](https://pypi.org/project/QtPy/)
and your code will still need to be written in a way generally compatible with both
libraries if you want to support both.
* `outputbox`: a `QTextEdit` widget for displaying log/output text of an application,
either by calling methods or by sending data to it over `zeromq`.
* `fonts`: bundled fonts from the Ubuntu font family - call `qtutils.fonts.load_fonts()`
after instantiating a `QApplication` to add them to the `Qt` font database and make
them available to your application.
## Using icons with Qt designer
To use the icons from Qt designer, clone this repository, and point Qt designer to the
`.qrc` file for the icons set: `icons/icons.qrc`. Unfortunately Qt desginer saves the
absolute path to this file in the resulting `.ui` file, so if the `.ui` file is later
edited by someone on another system, they will see an error at startup saying the `.qrc`
file cannot be found. This can be ignored and the `.ui` file will still function
correctly, but Qt designer will need to be told the local path to the `.qrc` file before
it can display the icons within its interface.
Raw data
{
"_id": null,
"home_page": null,
"name": "qtutils",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Qt, PyQt, PySide",
"author": null,
"author_email": "Philip Starkey <threepineapples@gmail.com>, Chris Billington <chrisjbillington@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/72/89/8474372b9d19b0b12c4fa94f7fa852b4e68cdd585b2ac04844be1ea597ca/qtutils-4.0.0.tar.gz",
"platform": null,
"description": "# qtutils\n\n[![Actions Status](https://github.com/philipstarkey/qtutils/workflows/Build%20and%20Release/badge.svg)](https://github.com/philipstarkey/qtutils/actions)\n![GitHub release](https://img.shields.io/github/last-commit/philipstarkey/qtutils.svg)\n[![Python Version](https://img.shields.io/pypi/pyversions/qtutils.svg)](https://python.org)\n[![Documentation Status](https://readthedocs.org/projects/qtutils/badge/?version=stable)](https://qtutils.readthedocs.io/en/stable/?badge=stable)\n[![PyPi Version](https://img.shields.io/pypi/v/qtutils.svg)](https://pypi.python.org/pypi/qtutils/) \n[![Conda Version](https://img.shields.io/conda/v/labscript-suite/qtutils)](https://anaconda.org/labscript-suite/qtutils)\n[![PyPi License](https://img.shields.io/pypi/l/qtutils.svg)](https://github.com/philipstarkey/qtutils/blob/master/LICENSE.txt) \n\nUtilities for providing concurrent access to Qt objects, simplified QSettings storage,\nand dynamic widget promotion when loading UI files, in Python Qt applications. Includes\nthe Fugue icon set, free to use with attribution to Yusuke Kamiyamane, and the Ubuntu\nfont family (available under the [Ubuntu font\nlicense](https://ubuntu.com/legal/font-licence)).\n\n* [Documentation](https://qtutils.readthedocs.io)\n* [PyPI](https://pypi.python.org/pypi/qtutils/)\n* [Source code (GitHub)](https://github.com/philipstarkey/qtutils)\n\n\n## Installation\n\n* To install the latest release version, run `pip install qtutils`.\n\n* To install latest development version, clone the GitHub repository and run `pip\n install .` to install, or `pip install -e .` to install in 'editable' mode.\n\n\n## Summary\n\n`qtutils` is a Python library that provides some convenient features to Python\napplications using the PyQt5/PySide6 widget library.\n\n`qtutils` 4.0 dropped support for PySide2. If you need to use PySide2, you may use\n`qtutils` 3.1.0 or earlier.\n\n`qtutils` contains the following components:\n\n* `invoke_in_main`: This provides some helper functions to interact with Qt from\n threads.\n\n* `UiLoader`: This provides a simplified means of promoting widgets in `*.ui` files to a\n custom widget of your choice.\n\n* `qsettings_wrapper`: A wrapper around QSettings which allows you to access keys of\n QSettings as instance attributes. It also performs automatic type conversions.\n\n* `icons`: An icon set as a `QResource` file and corresponding Python module. The\n resulting resource file can be used by Qt designer, and the python module imported by\n applications to make the icons available to them. The Fugue icon set was made by\n Yusuke Kamiyamane, and is licensed under a Creative Commons Attribution 3.0 License.\n If you can't or don't want to provide attribution, please purchase a royalty-free\n license from http://p.yusukekamiyamane.com/\n\n* `Qt`: a PyQt5/PySide6 agnostic interface to Qt that allows you to import qtutils.qt\n instead of PySide6 or PyQt5, and have your code run on both, with some convenience\n aliases to make it easier to write code that works with both libraries. Note that this\n is not a comprehensive abstraction layer like [QtPy](https://pypi.org/project/QtPy/)\n and your code will still need to be written in a way generally compatible with both\n libraries if you want to support both.\n\n* `outputbox`: a `QTextEdit` widget for displaying log/output text of an application,\n either by calling methods or by sending data to it over `zeromq`.\n\n* `fonts`: bundled fonts from the Ubuntu font family - call `qtutils.fonts.load_fonts()`\n after instantiating a `QApplication` to add them to the `Qt` font database and make\n them available to your application.\n\n\n## Using icons with Qt designer\n\nTo use the icons from Qt designer, clone this repository, and point Qt designer to the\n`.qrc` file for the icons set: `icons/icons.qrc`. Unfortunately Qt desginer saves the\nabsolute path to this file in the resulting `.ui` file, so if the `.ui` file is later\nedited by someone on another system, they will see an error at startup saying the `.qrc`\nfile cannot be found. This can be ignored and the `.ui` file will still function\ncorrectly, but Qt designer will need to be told the local path to the `.qrc` file before\nit can display the icons within its interface.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2013, Christopher Billington, Philip Starkey All rights reserved. This project (qtutils) is dual licensed under the 2-clause BSD license and 3-clause BSD license (see the files BSD-2-CLAUSE-LICENSE.txt and BSD-3-CLAUSE-LICENSE.txt), subject to the following conditions: 1) If you wish to use this project with PySide and/or a commercial license of PyQt, the use of this project is governed by the terms of one of the licenses, chosen at your discretion. 2) If you wish to use this project with the free (GPLv2 or GPLv3 licensed) version of PyQt, the use of this project is governed by the terms of the 3-clause BSD license only, along with the terms specified in the GPL_EXCEPTIONS.TXT file in the PyQt project source code. These terms are in place to guarantee compatibility with the terms outlined in the GPL License Exceptions of the PyQt project (see the GPL_EXCEPTIONS.TXT file in the source code of the PyQt project) This project includes the Fugue icon set by Yusuke Kamiyamane, licensed under a Creative Commons Attribution 3.0 License. See icons/LICENSE.txt. This project includes the Ubuntu Mono font by Canonical, licensed under the Ubuntu Font License 1.0, see: https://ubuntu.com/legal/font-licence ",
"summary": "PySide6/PyQt5 abstraction layer, mulithreading and UI loader utilities, icon set, and more",
"version": "4.0.0",
"project_urls": {
"Documentation": "https://readthedocs.org/projects/qtutils/",
"Downloads": "https://pypi.org/project/qtutils/",
"Homepage": "https://github.com/philipstarkey/qtutils",
"Repository": "https://github.com/philipstarkey/qtutils",
"Tracker": "https://github.com/philipstarkey/qtutils/issues"
},
"split_keywords": [
"qt",
" pyqt",
" pyside"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "af38300b6ab6b7abb374006aa5a2b529064a784049fee7b7e6c7795df166b94d",
"md5": "608e74cb30df63e81b79ad4276a59b87",
"sha256": "f6aec3b23a2a6fa95e7867cc410da48c4d935813bb43fa1a58715bb1634c101d"
},
"downloads": -1,
"filename": "qtutils-4.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "608e74cb30df63e81b79ad4276a59b87",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 23451588,
"upload_time": "2024-12-17T01:36:11",
"upload_time_iso_8601": "2024-12-17T01:36:11.131763Z",
"url": "https://files.pythonhosted.org/packages/af/38/300b6ab6b7abb374006aa5a2b529064a784049fee7b7e6c7795df166b94d/qtutils-4.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "72898474372b9d19b0b12c4fa94f7fa852b4e68cdd585b2ac04844be1ea597ca",
"md5": "3f7eac329d9351d980adfe20c5b0c528",
"sha256": "578e00e298f20239b906cc1f39741de54d26df2495d5b7e8a740d94452bbc2b8"
},
"downloads": -1,
"filename": "qtutils-4.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3f7eac329d9351d980adfe20c5b0c528",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7144644,
"upload_time": "2024-12-17T01:36:15",
"upload_time_iso_8601": "2024-12-17T01:36:15.683103Z",
"url": "https://files.pythonhosted.org/packages/72/89/8474372b9d19b0b12c4fa94f7fa852b4e68cdd585b2ac04844be1ea597ca/qtutils-4.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 01:36:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "philipstarkey",
"github_project": "qtutils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "qtutils"
}