| Name | QtMDi JSON |
| Version |
1.1.29
JSON |
| download |
| home_page | None |
| Summary | QtMDI (Qt Material Design Icons) |
| upload_time | 2024-12-06 02:47:01 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | The MIT License Copyright (c) 2015 The Spyder development team Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
pyqt
pyside
material-icons
material-symbols
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[![SWUbanner]][SWUdocs]
[SWUbanner]:
https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg
[SWUdocs]:
https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md
# QtMDi (Qt Material Design icons)
[](https://opensource.org/licenses/MIT)
[](https://pypi.org/project/QtMDi/)
*Copyright 2023 Yaroshenko Dmytro (https://github.com/o-murphy)*
### The extension for [QtAwesome](https://github.com/spyder-ide/qtawesome) with the latest variable icon fonts for Material Symbols
#### (Python 3, PySide, PyQt)
> [!NOTE]
> Fonts in this package automatically updated, so it will always have the latest icons from Google
> [!NOTE]
> The package is publishing to PyPi automatically, so it can have issues in some releases
> [!NOTE]
> The package uses [QtAwesome](https://github.com/spyder-ide/qtawesome) as it's backend,
> so it support all the feature provided by QtAwesome, for more [see the docs](https://github.com/spyder-ide/qtawesome/blob/master/README.md)
- [Installation](#installation)
- [Usage](#usage)
- [Supported Fonts](#supported-fonts)
- [Available Icons](#available-icons)
- [Known issues](#known-issues)
## Installation
Install the [latest release][releases] from PyPi using:
```sh
pip install QtMDi
```
Install the latest updated version from github:
```sh
pip install https://github.com/o-murphy/QtMDi
```
## Usage
### Supported Fonts
QtAwesome identifies icons by their prefix and their icon name, separated by a period (.) character.
The following prefixes are currently available to use:
* `mds` prefix has [Google material design icons](https://github.com/google/material-design-icons) symbols style
* `mdf` prefix has [Google material design icons](https://github.com/google/material-design-icons) variablefont style
### Example
#### Import qtawesome and qtmdi in your python file:
```python
import qtawesome
import qtmdi
```
#### Icon creation example
```python
# basic rounded
qtawesome.icon("mds-rounded-base.home")
# rounded with 700 width
qtawesome.icon("mds-rounded-700.home")
# rounded with 400 width
qtawesome.icon("mds-sharp-400.home")
# basic variablefont ttf based icon
qtawesome.icon("mdf-sharp.home")
```
#### Create an app
```python
from qtpy import QtWidgets
class Example(QtWidgets.QMainWindow):
def __init__(self):
super().__init__()
self.lt = QtWidgets.QVBoxLayout(self)
self.btn = QtWidgets.QToolButton(self)
self.btn.setIcon(
qtawesome.icon("mdi-rounded-700.home_filled"),
)
self.btn.setFixedSize(48, 48)
self.btn.setIconSize(32, 32)
self.lt.addWidget(self.btn)
```
#### Load extension on your app instance
```python
import sys
from qtpy import QtWidgets
import qtawesome
import qtmdi
# Create an app
class Example(QtWidgets.QMainWindow):
def __init__(self):
super().__init__()
self.lt = QtWidgets.QVBoxLayout(self)
self.btn = QtWidgets.QToolButton(self)
self.btn.setIcon(
qtawesome.icon("mds-rounded-700.home"),
)
self.btn.setFixedSize(48, 48)
self.btn.setIconSize(32, 32)
self.lt.addWidget(self.btn)
def run():
app = QtWidgets.QApplication()
# Load extension on your app instance
qtmdi.load(app)
qtawesome.dark(app)
w = Example()
w.show()
sys.exit(app.exec_())
if __name__ == '__main__':
run()
```
## Available Icons
To see available icons run qtmdi-browser in your terminal
```sh
qtmdi-browser
```
## Known issues
* Filled icons not shown as expected
* `Grade` property currently unsupported
* `Optical size` property currently unsupported
## License
* MIT License. Copyright 2023 Yaroshenko Dmytro (https://github.com/o-murphy)
See the [LICENSE](LICENSE) file for details.
- The [Google material design icons](https://github.com/google/material-design-icons) fonts is licensed under the [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
- The [material-symbols](https://github.com/marella/material-symbols) package is licensed under the [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
- The [QtAwesome](https://github.com/spyder-ide/qtawesome) licensed under the MIT License. Copyright 2015 - The Spyder development team.
See the [LICENSE](https://github.com/spyder-ide/qtawesome/blob/master/LICENSE.txt) file for details.
- The [Font Awesome](https://github.com/FortAwesome/Font-Awesome/blob/master/LICENSE.txt) and [Elusive Icons](http://elusiveicons.com/license/) fonts are licensed under the [SIL Open Font License](http://scripts.sil.org/OFL).
- The Phosphor font is licensed under the [MIT License](https://github.com/phosphor-icons/phosphor-icons/blob/master/LICENSE).
- The [Material Design Icons](https://github.com/Templarian/MaterialDesign/blob/master/LICENSE) font is licensed under the [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
- The Remix Icon font is licensed under the [Apache License Version 2.0](https://github.com/Remix-Design/remixicon/blob/master/License).
- Microsoft's Codicons are licensed under a [Creative Commons Attribution 4.0 International Public License](https://github.com/microsoft/vscode-codicons/blob/master/LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "QtMDi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "pyqt, pyside, material-icons, material-symbols",
"author": null,
"author_email": "o-murphy <thehelixpg@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/51/7f/327e6a576908c7ee325c7e12df7ec9056bba3ad3511ceb21f5cc50b64f26/qtmdi-1.1.29.tar.gz",
"platform": null,
"description": "[![SWUbanner]][SWUdocs]\n\n[SWUbanner]:\nhttps://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg\n[SWUdocs]:\nhttps://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md\n\n# QtMDi (Qt Material Design icons)\n\n[](https://opensource.org/licenses/MIT)\n[](https://pypi.org/project/QtMDi/)\n\n*Copyright 2023 Yaroshenko Dmytro (https://github.com/o-murphy)*\n\n### The extension for [QtAwesome](https://github.com/spyder-ide/qtawesome) with the latest variable icon fonts for Material Symbols\n#### (Python 3, PySide, PyQt)\n\n> [!NOTE]\n> Fonts in this package automatically updated, so it will always have the latest icons from Google\n\n> [!NOTE]\n> The package is publishing to PyPi automatically, so it can have issues in some releases\n\n> [!NOTE]\n> The package uses [QtAwesome](https://github.com/spyder-ide/qtawesome) as it's backend,\n> so it support all the feature provided by QtAwesome, for more [see the docs](https://github.com/spyder-ide/qtawesome/blob/master/README.md)\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Supported Fonts](#supported-fonts)\n- [Available Icons](#available-icons)\n- [Known issues](#known-issues)\n\n## Installation\n\nInstall the [latest release][releases] from PyPi using:\n```sh\npip install QtMDi\n```\n\nInstall the latest updated version from github:\n```sh\npip install https://github.com/o-murphy/QtMDi\n```\n\n## Usage\n\n### Supported Fonts\nQtAwesome identifies icons by their prefix and their icon name, separated by a period (.) character.\n\nThe following prefixes are currently available to use:\n* `mds` prefix has [Google material design icons](https://github.com/google/material-design-icons) symbols style\n* `mdf` prefix has [Google material design icons](https://github.com/google/material-design-icons) variablefont style\n\n### Example\n\n#### Import qtawesome and qtmdi in your python file:\n\n```python\nimport qtawesome\nimport qtmdi\n```\n\n#### Icon creation example\n```python\n# basic rounded\nqtawesome.icon(\"mds-rounded-base.home\")\n\n# rounded with 700 width\nqtawesome.icon(\"mds-rounded-700.home\")\n\n# rounded with 400 width\nqtawesome.icon(\"mds-sharp-400.home\")\n\n# basic variablefont ttf based icon\nqtawesome.icon(\"mdf-sharp.home\")\n```\n\n#### Create an app\n\n```python\nfrom qtpy import QtWidgets\n\nclass Example(QtWidgets.QMainWindow):\n def __init__(self):\n super().__init__()\n self.lt = QtWidgets.QVBoxLayout(self)\n self.btn = QtWidgets.QToolButton(self)\n self.btn.setIcon(\n qtawesome.icon(\"mdi-rounded-700.home_filled\"),\n )\n self.btn.setFixedSize(48, 48)\n self.btn.setIconSize(32, 32)\n self.lt.addWidget(self.btn)\n```\n\n#### Load extension on your app instance\n```python\nimport sys\nfrom qtpy import QtWidgets\nimport qtawesome\nimport qtmdi\n\n\n# Create an app\nclass Example(QtWidgets.QMainWindow):\n def __init__(self):\n super().__init__()\n self.lt = QtWidgets.QVBoxLayout(self)\n self.btn = QtWidgets.QToolButton(self)\n self.btn.setIcon(\n qtawesome.icon(\"mds-rounded-700.home\"),\n )\n self.btn.setFixedSize(48, 48)\n self.btn.setIconSize(32, 32)\n self.lt.addWidget(self.btn)\n \ndef run():\n app = QtWidgets.QApplication()\n \n # Load extension on your app instance\n qtmdi.load(app)\n \n qtawesome.dark(app)\n w = Example()\n w.show()\n sys.exit(app.exec_())\n \nif __name__ == '__main__': \n run()\n```\n\n## Available Icons\nTo see available icons run qtmdi-browser in your terminal\n\n```sh\nqtmdi-browser\n```\n\n## Known issues\n* Filled icons not shown as expected\n* `Grade` property currently unsupported\n* `Optical size` property currently unsupported\n\n## License\n* MIT License. Copyright 2023 Yaroshenko Dmytro (https://github.com/o-murphy)\nSee the [LICENSE](LICENSE) file for details.\n\n- The [Google material design icons](https://github.com/google/material-design-icons) fonts is licensed under the [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).\n\n- The [material-symbols](https://github.com/marella/material-symbols) package is licensed under the [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).\n\n- The [QtAwesome](https://github.com/spyder-ide/qtawesome) licensed under the MIT License. Copyright 2015 - The Spyder development team.\nSee the [LICENSE](https://github.com/spyder-ide/qtawesome/blob/master/LICENSE.txt) file for details.\n\n- The [Font Awesome](https://github.com/FortAwesome/Font-Awesome/blob/master/LICENSE.txt) and [Elusive Icons](http://elusiveicons.com/license/) fonts are licensed under the [SIL Open Font License](http://scripts.sil.org/OFL).\n\n- The Phosphor font is licensed under the [MIT License](https://github.com/phosphor-icons/phosphor-icons/blob/master/LICENSE).\n\n- The [Material Design Icons](https://github.com/Templarian/MaterialDesign/blob/master/LICENSE) font is licensed under the [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).\n\n- The Remix Icon font is licensed under the [Apache License Version 2.0](https://github.com/Remix-Design/remixicon/blob/master/License).\n\n- Microsoft's Codicons are licensed under a [Creative Commons Attribution 4.0 International Public License](https://github.com/microsoft/vscode-codicons/blob/master/LICENSE).\n",
"bugtrack_url": null,
"license": "The MIT License Copyright (c) 2015 The Spyder development team Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "QtMDI (Qt Material Design Icons)",
"version": "1.1.29",
"project_urls": {
"Bug Reports": "https://github.com/o-murphy/QtMDi/issues",
"Homepage": "https://github.com/o-murphy/QtMDi",
"Source": "https://github.com/o-murphy/QtMDi"
},
"split_keywords": [
"pyqt",
" pyside",
" material-icons",
" material-symbols"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ddeff5d59942519fd7a0d9db2cc34a38ed8db91ee34b237cd70bcf97f7cf21e",
"md5": "8bd10bb031ecca066fe412b3ffe447b3",
"sha256": "bf43d4526ff845c4ecb6b3ad83b560d0b3fdeaae224a6f965fea039d2d03286e"
},
"downloads": -1,
"filename": "QtMDi-1.1.29-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8bd10bb031ecca066fe412b3ffe447b3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 27432412,
"upload_time": "2024-12-06T02:46:56",
"upload_time_iso_8601": "2024-12-06T02:46:56.971437Z",
"url": "https://files.pythonhosted.org/packages/4d/de/ff5d59942519fd7a0d9db2cc34a38ed8db91ee34b237cd70bcf97f7cf21e/QtMDi-1.1.29-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "517f327e6a576908c7ee325c7e12df7ec9056bba3ad3511ceb21f5cc50b64f26",
"md5": "c0fe50b634af672e8d306a505dfdbf2b",
"sha256": "63c5018e73a6a87cb5c228505eb4cf6b532c36edb30d413e776fae60c702df5d"
},
"downloads": -1,
"filename": "qtmdi-1.1.29.tar.gz",
"has_sig": false,
"md5_digest": "c0fe50b634af672e8d306a505dfdbf2b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 27390037,
"upload_time": "2024-12-06T02:47:01",
"upload_time_iso_8601": "2024-12-06T02:47:01.007461Z",
"url": "https://files.pythonhosted.org/packages/51/7f/327e6a576908c7ee325c7e12df7ec9056bba3ad3511ceb21f5cc50b64f26/qtmdi-1.1.29.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 02:47:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "o-murphy",
"github_project": "QtMDi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "qtmdi"
}
