Skip to main content

FontAwesome icons in PyQt and PySide applications

Project description

QtAwesome

license pypi version conda version download count OpenCollective Backers Join the chat at https://gitter.im/spyder-ide/public
PyPI status Appveyor build status CircleCI build status Documentation Status

Copyright © 2015–2018 Spyder Project Contributors

Description

QtAwesome enables iconic fonts such as Font Awesome and Elusive Icons in PyQt and PySide applications.

It started as a Python port of the QtAwesome C++ library by Rick Blommers.

Installation

Using pip:

Make sure you have pip installed and run:

pip install qtawesome

Using conda:

conda install qtawesome

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:

Examples

import qtawesome as qta
  • Use Font Awesome, Elusive Icons or Material Design Icons.
# Get FontAwesome 5.x icons by name in various styles:
fa5_icon = qta.icon('fa5.flag')
fa5_button = QtGui.QPushButton(fa5_icon, 'Font Awesome! (regular)')
fa5s_icon = qta.icon('fa5s.flag')
fa5s_button = QtGui.QPushButton(fa5s_icon, 'Font Awesome! (solid)')
fa5b_icon = qta.icon('fa5b.github')
fa5b_button = QtGui.QPushButton(fa5b_icon, 'Font Awesome! (brands)')

# or Elusive Icons:
asl_icon = qta.icon('ei.asl')
elusive_button = QtGui.QPushButton(asl_icon, 'Elusive Icons!')

# or Material Design Icons:
apn_icon = qta.icon('mdi.access-point-network')
mdi_button = QtGui.QPushButton(apn_icon, 'Material Design Icons!')
  • Apply some styling
# Styling icons
styling_icon = qta.icon('fa5s.music',
                        active='fa5s.balance-scale',
                        color='blue',
                        color_active='orange')
music_button = QtGui.QPushButton(styling_icon, 'Styling')
  • Stack multiple icons
# Stacking icons
camera_ban = qta.icon('fa5s.camera', 'fa5s.ban',
                      options=[{'scale_factor': 0.5,
                                'active': 'fa5s.balance-scale'},
                               {'color': 'red'}])
stack_button = QtGui.QPushButton(camera_ban, 'Stack')
stack_button.setIconSize(QtCore.QSize(32, 32))
  • Animations
# Spining icons
spin_button = QtGui.QPushButton(' Spinning icon')
spin_icon = qta.icon('fa5s.spinner', color='red',
                     animation=qta.Spin(spin_button))
spin_button.setIcon(spin_icon)
  • Screenshot

QtAwesome screenshot

Other features

  • QtAwesome comes bundled with Font Awesome, Elusive Icons and Material Design Icons but it can also be used with other iconic fonts. The load_font function allows to load other fonts dynamically.
  • QtAwesome relies on the QtPy project as a compatibility layer on the top ot PyQt or PySide.

License

MIT License. Copyright 2015 - The Spyder development team. See the LICENSE file for details.

The Font Awesome, Elusive Icons and Material Design Icons fonts are licensed under the SIL Open Font License.

Contributing

Everyone is welcome to contribute!

Backers

Support us with a monthly donation and help us continue our activities.

Backers

Sponsors

Become a sponsor to get your logo on our README on Github.

Sponsors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

QtAwesome-0.5.6.tar.gz (642.2 kB view details)

Uploaded Source

Built Distribution

QtAwesome-0.5.6-py2.py3-none-any.whl (628.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file QtAwesome-0.5.6.tar.gz.

File metadata

  • Download URL: QtAwesome-0.5.6.tar.gz
  • Upload date:
  • Size: 642.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.3

File hashes

Hashes for QtAwesome-0.5.6.tar.gz
Algorithm Hash digest
SHA256 e3fa38cf55244bf2cbc24f7f176da86a45ab7aa63dd09b33c1247eaa2adecd38
MD5 f54e21fd23c1e1d97c95b0378368f12d
BLAKE2b-256 e0bb958f0eabf721e91293bf745b5d785a44d3bea3a8fe8150fc58a0c0c567c2

See more details on using hashes here.

Provenance

File details

Details for the file QtAwesome-0.5.6-py2.py3-none-any.whl.

File metadata

  • Download URL: QtAwesome-0.5.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 628.6 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.3

File hashes

Hashes for QtAwesome-0.5.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 afb93500b180a185c2452dd1e39d4544471bcb60508cd27814ebec9815fdff08
MD5 50b47bcb08b8487c961753779137d322
BLAKE2b-256 886d2c9afe28fae035306537b593147cd9d199fd1d802902beb9524065f46f97

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page