Name | pyqtribbon JSON |
Version |
0.7.4
JSON |
| download |
home_page | |
Summary | Ribbon Bar for PyQt or PySide applications |
upload_time | 2023-07-23 08:51:40 |
maintainer | |
docs_url | None |
author | |
requires_python | >=3.7 |
license | |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# PyQtRibbon
[![Documentation Status](https://readthedocs.org/projects/pyqribbon/badge/?version=latest)](https://pyqtribbon.haiiliin.com/en/stable/?badge=latest)
[![Tests](https://github.com/haiiliin/pyqtribbon/actions/workflows/tests.yml/badge.svg)](https://github.com/haiiliin/pyqtribbon/actions/workflows/tests.yml)
[![PyPI](https://github.com/haiiliin/pyqtribbon/actions/workflows/publish.yml/badge.svg)](https://github.com/haiiliin/pyqtribbon/actions/workflows/publish.yml)
[![Coverage Status](https://coveralls.io/repos/github/haiiliin/pyqtribbon/badge.svg?branch=main)](https://coveralls.io/github/haiiliin/pyqtribbon?branch=main)
[![PyPI license](https://img.shields.io/pypi/l/pyqtribbon.svg)](https://github.com/haiiliin/pyqtribbon/blob/main/LICENSE)
[![PyPI pyversions](https://img.shields.io/pypi/pyversions/pyqtribbon.svg)](https://www.python.org/)
[![PyPI](https://img.shields.io/pypi/v/pyqtribbon)](https://pypi.org/project/pyqtribbon/)
[![PyPI download month](https://img.shields.io/pypi/dm/pyqtribbon.svg)](https://pypi.org/project/pyqtribbon/)
Ribbon Bar for PyQt or PySide applications.
- GitHub Repository: [github.com/haiiliin/pyqtribbon](https://github.com/haiiliin/pyqtribbon/).
- Documentation: [pyqtribbon.haiiliin.com/en/stable](https://pyqtribbon.haiiliin.com/en/stable/).
- Python Package Index: [pypi.org/project/pyqtribbon](https://pypi.org/project/pyqtribbon/).
- Read the Docs: [readthedocs.org/projects/pyqribbon](https://readthedocs.org/projects/pyqribbon/).
## Installation
PyQtRibbon is distributed to [PyPI](https://pypi.org/project/pyqtribbon/), you can use pip to install it:
```shell
pip install pyqtribbon
```
You can also install the package from source:
```shell
pip install git+https://github.com/haiiliin/pyqtribbon.git@main
```
## Compatible Python and PyQt/PySide Versions
| [Python][py] | [PyQt5][PyQt5] | [PyQt6][PyQt6] | [PySide2][PySide2] | [PySide6][PySide6] |
|:------------:|:-------------------:|:------------------:|:------------------:|:------------------:|
| 3.7 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| 3.8 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| 3.9 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| 3.10 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| 3.11 | :white_check_mark: | :white_check_mark: | :x: [^1] | :white_check_mark: |
[py]: https://www.python.org/
[PyQt5]: https://pypi.org/project/PyQt5/
[PyQt6]: https://pypi.org/project/PyQt6/
[PySide2]: https://pypi.org/project/PySide2/
[PySide6]: https://pypi.org/project/PySide6/
[^1]: PySide2 does not support Python 3.11 yet.
## The Ribbon Bar
The ribbon is first introduced by Microsoft in the 2000's. It is a toolbar with a tabbed interface. According to [Microsoft](https://docs.microsoft.com/en-us/cpp/mfc/ribbon-designer-mfc?view=msvc-170):
- A ribbon is a user interface (UI) element that organizes commands into logical groups. These groups appear on separate tabs in a strip across the top of the window. The ribbon replaces the menu bar and toolbars. A ribbon can significantly improve application usability. For more information, see Ribbons. The following illustration shows a ribbon. A ribbon can significantly improve application usability. For more information, see [Ribbons](https://docs.microsoft.com/en-us/windows/win32/uxguide/cmd-ribbons). The following illustration shows a ribbon.
![ribbon_no_callouts](docs/source/_images/ribbon_no_callouts.png)
## Definitions of Ribbon Elements
- **Application button**: The button that appears in the upper-left corner of a ribbon. The Application button replaces the File menu and is visible even when the ribbon is minimized. When the button is clicked, a menu that has a list of commands is displayed.
- **Quick Access toolbar**: A small, customizable toolbar that displays frequently used commands.
- **Category**: The logical grouping that represents the contents of a ribbon tab.
- **Category Default button**: The button that appears on the ribbon when the ribbon is minimized. When the button is clicked, the category reappears as a menu.
- **Panel**: An area of the ribbon bar that displays a group of related controls. Every ribbon category contains one or more ribbon panels.
- **Ribbon elements**: Controls in the panels, for example, buttons and combo boxes. To see the various controls that can be hosted on a ribbon, see RibbonGadgets Sample: Ribbon Gadgets Application.
## Screenshots
![An Example](screenshots/main.png)
Raw data
{
"_id": null,
"home_page": "",
"name": "pyqtribbon",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "WANG Hailin <hailin.wang@connect.polyu.hk>",
"download_url": "https://files.pythonhosted.org/packages/82/82/8d895f3d67682f1e4daee2b027f2cd4b532cc963fff3e76cb2a3e1282d3e/pyqtribbon-0.7.4.tar.gz",
"platform": null,
"description": "# PyQtRibbon\n\n[![Documentation Status](https://readthedocs.org/projects/pyqribbon/badge/?version=latest)](https://pyqtribbon.haiiliin.com/en/stable/?badge=latest)\n[![Tests](https://github.com/haiiliin/pyqtribbon/actions/workflows/tests.yml/badge.svg)](https://github.com/haiiliin/pyqtribbon/actions/workflows/tests.yml)\n[![PyPI](https://github.com/haiiliin/pyqtribbon/actions/workflows/publish.yml/badge.svg)](https://github.com/haiiliin/pyqtribbon/actions/workflows/publish.yml)\n[![Coverage Status](https://coveralls.io/repos/github/haiiliin/pyqtribbon/badge.svg?branch=main)](https://coveralls.io/github/haiiliin/pyqtribbon?branch=main)\n\n[![PyPI license](https://img.shields.io/pypi/l/pyqtribbon.svg)](https://github.com/haiiliin/pyqtribbon/blob/main/LICENSE)\n[![PyPI pyversions](https://img.shields.io/pypi/pyversions/pyqtribbon.svg)](https://www.python.org/)\n[![PyPI](https://img.shields.io/pypi/v/pyqtribbon)](https://pypi.org/project/pyqtribbon/)\n[![PyPI download month](https://img.shields.io/pypi/dm/pyqtribbon.svg)](https://pypi.org/project/pyqtribbon/)\n\nRibbon Bar for PyQt or PySide applications.\n\n- GitHub Repository: [github.com/haiiliin/pyqtribbon](https://github.com/haiiliin/pyqtribbon/).\n- Documentation: [pyqtribbon.haiiliin.com/en/stable](https://pyqtribbon.haiiliin.com/en/stable/).\n- Python Package Index: [pypi.org/project/pyqtribbon](https://pypi.org/project/pyqtribbon/).\n- Read the Docs: [readthedocs.org/projects/pyqribbon](https://readthedocs.org/projects/pyqribbon/).\n\n## Installation\n\nPyQtRibbon is distributed to [PyPI](https://pypi.org/project/pyqtribbon/), you can use pip to install it:\n\n```shell\npip install pyqtribbon\n```\n\nYou can also install the package from source:\n```shell\npip install git+https://github.com/haiiliin/pyqtribbon.git@main\n```\n\n## Compatible Python and PyQt/PySide Versions\n\n| [Python][py] | [PyQt5][PyQt5] | [PyQt6][PyQt6] | [PySide2][PySide2] | [PySide6][PySide6] |\n|:------------:|:-------------------:|:------------------:|:------------------:|:------------------:|\n| 3.7 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |\n| 3.8 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |\n| 3.9 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |\n| 3.10 | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |\n| 3.11 | :white_check_mark: | :white_check_mark: | :x: [^1] | :white_check_mark: |\n\n[py]: https://www.python.org/\n[PyQt5]: https://pypi.org/project/PyQt5/\n[PyQt6]: https://pypi.org/project/PyQt6/\n[PySide2]: https://pypi.org/project/PySide2/\n[PySide6]: https://pypi.org/project/PySide6/\n[^1]: PySide2 does not support Python 3.11 yet.\n\n## The Ribbon Bar\n\nThe ribbon is first introduced by Microsoft in the 2000's. It is a toolbar with a tabbed interface. According to [Microsoft](https://docs.microsoft.com/en-us/cpp/mfc/ribbon-designer-mfc?view=msvc-170):\n\n- A ribbon is a user interface (UI) element that organizes commands into logical groups. These groups appear on separate tabs in a strip across the top of the window. The ribbon replaces the menu bar and toolbars. A ribbon can significantly improve application usability. For more information, see Ribbons. The following illustration shows a ribbon. A ribbon can significantly improve application usability. For more information, see [Ribbons](https://docs.microsoft.com/en-us/windows/win32/uxguide/cmd-ribbons). The following illustration shows a ribbon.\n \n ![ribbon_no_callouts](docs/source/_images/ribbon_no_callouts.png)\n\n## Definitions of Ribbon Elements\n\n- **Application button**: The button that appears in the upper-left corner of a ribbon. The Application button replaces the File menu and is visible even when the ribbon is minimized. When the button is clicked, a menu that has a list of commands is displayed.\n\n- **Quick Access toolbar**: A small, customizable toolbar that displays frequently used commands.\n\n- **Category**: The logical grouping that represents the contents of a ribbon tab.\n\n- **Category Default button**: The button that appears on the ribbon when the ribbon is minimized. When the button is clicked, the category reappears as a menu.\n\n- **Panel**: An area of the ribbon bar that displays a group of related controls. Every ribbon category contains one or more ribbon panels.\n\n- **Ribbon elements**: Controls in the panels, for example, buttons and combo boxes. To see the various controls that can be hosted on a ribbon, see RibbonGadgets Sample: Ribbon Gadgets Application.\n\n## Screenshots\n\n![An Example](screenshots/main.png)\n",
"bugtrack_url": null,
"license": "",
"summary": "Ribbon Bar for PyQt or PySide applications",
"version": "0.7.4",
"project_urls": {
"Documentation": "https://pyqtribbon.haiiliin.com/en/stable/",
"GitHub": "https://github.com/haiiliin/pyqtribbon"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "db2a2c529d256b6c30c75d6e0c33aa1f722ac859916f383a434ef1005fe2f7f4",
"md5": "f8a98c678a13291809fdf625ca88b7a7",
"sha256": "748ed8951d56851f56fce417073dc4202e4e22930c32ebda6ccfc6a776de7ba0"
},
"downloads": -1,
"filename": "pyqtribbon-0.7.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f8a98c678a13291809fdf625ca88b7a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 49365,
"upload_time": "2023-07-23T08:51:38",
"upload_time_iso_8601": "2023-07-23T08:51:38.668313Z",
"url": "https://files.pythonhosted.org/packages/db/2a/2c529d256b6c30c75d6e0c33aa1f722ac859916f383a434ef1005fe2f7f4/pyqtribbon-0.7.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "82828d895f3d67682f1e4daee2b027f2cd4b532cc963fff3e76cb2a3e1282d3e",
"md5": "e9a525bf0795d492f0de86ddee80f305",
"sha256": "83113e9eb92d731b085182753c28d34bc3c5e340bdc5d875a6baae363e9c36b2"
},
"downloads": -1,
"filename": "pyqtribbon-0.7.4.tar.gz",
"has_sig": false,
"md5_digest": "e9a525bf0795d492f0de86ddee80f305",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 336195,
"upload_time": "2023-07-23T08:51:40",
"upload_time_iso_8601": "2023-07-23T08:51:40.303984Z",
"url": "https://files.pythonhosted.org/packages/82/82/8d895f3d67682f1e4daee2b027f2cd4b532cc963fff3e76cb2a3e1282d3e/pyqtribbon-0.7.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-23 08:51:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "haiiliin",
"github_project": "pyqtribbon",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pyqtribbon"
}