QtAwesome

https://github.com/spyder-ide/qtawesome
Admin
QtAwesome enables iconic fonts such as Font Awesome and Elusive Icons in PyQt and PySide...
Tokens:8,569
Snippets:103
Trust Score:9.6
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Run Example Script with Options

Source: https://github.com/spyder-ide/qtawesome/blob/master/README.md

Execute the example script with specific options passed as command-line arguments to test different features, such as drawing methods.

```bash
python example.py draw=glyphrun

```

--------------------------------

### Install PyQt5 and WebEngine with Pip

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Install specific versions of PyQt5 and PyQtWebEngine using pip.

```bash
python -m pip install pyqt5==5.* PyQtWebEngine==5.*
```

--------------------------------

### Install QtAwesome using Pip

Source: https://github.com/spyder-ide/qtawesome/blob/master/README.md

Use this command to install QtAwesome if you do not have conda installed.

```bash
pip install qtawesome
```

--------------------------------

### Install QtAwesome (Editable Mode, No Deps)

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Install QtAwesome in editable mode without dependencies, typically after setting up specific Qt bindings.

```bash
python -m pip install -e . --no-deps
```

--------------------------------

### Install QtAwesome using Conda

Source: https://github.com/spyder-ide/qtawesome/blob/master/README.md

Use this command to install QtAwesome if you have conda installed.

```bash
conda install qtawesome
```

--------------------------------

### Install QtAwesome (Editable Mode with Test Deps)

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Install QtAwesome in editable mode, including test dependencies, after installing PyQt5 and PyQtWebEngine.

```bash
python -m pip install -e .[test]
```

--------------------------------

### Install Dependencies with Conda

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Update the Conda environment using the requirements file for PyQt5 development.

```bash
conda env update --file requirements/environment.yml
```

--------------------------------

### Get Icons from Various Icon Sets

Source: https://github.com/spyder-ide/qtawesome/blob/master/README.md

Demonstrates how to retrieve icons from different icon sets like Font Awesome (v5 and v6), Elusive Icons, Material Design Icons, Phosphor, Remix Icon, and Codicons by their names.

```python
# Get FontAwesome 6.x icons by name in various styles:
fa6_icon = qta.icon('fa6.flag')
fa6_button = QtWidgets.QPushButton(fa6_icon, 'Font Awesome 6! (regular)')
fa6s_icon = qta.icon('fa6s.flag')
fa6s_button = QtWidgets.QPushButton(fa6s_icon, 'Font Awesome 6! (solid)')
fa6b_icon = qta.icon('fa6b.github')
fa6b_button = QtWidgets.QPushButton(fa6b_icon, 'Font Awesome 6! (brands)')

# or FontAwesome 5.x icons by name in various styles:
fa5_icon = qta.icon('fa5.flag')
fa5_button = QtWidgets.QPushButton(fa5_icon, 'Font Awesome 5! (regular)')
fa5s_icon = qta.icon('fa5s.flag')
fa5s_button = QtWidgets.QPushButton(fa5s_icon, 'Font Awesome 5! (solid)')
fa5b_icon = qta.icon('fa5b.github')
fa5b_button = QtWidgets.QPushButton(fa5b_icon, 'Font Awesome 5! (brands)')

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

# or Material Design Icons:
apn_icon = qta.icon('mdi6.access-point-network')
mdi6_button = QtWidgets.QPushButton(apn_icon, 'Material Design Icons!')

# or Phosphor:
mic_icon = qta.icon('ph.microphone-fill')
ph_button = QtWidgets.QPushButton(mic_icon, 'Phosphor!')

# or Remix Icon:
truck_icon = qta.icon('ri.truck-fill')
ri_button = QtWidgets.QPushButton(truck_icon, 'Remix Icon!')

# or Microsoft's Codicons:
squirrel_icon = qta.icon('msc.squirrel')
msc_button = QtWidgets.QPushButton(squirrel_icon, 'Codicons!')

```

--------------------------------

### Create and Activate Release Environment

Source: https://github.com/spyder-ide/qtawesome/blob/master/RELEASE.md

Creates a new conda environment named 'release' with Python 3.9 and installs necessary release management packages.

```bash
conda create -n release python=3.9
conda activate release
pip install -U pip setuptools twine wheel loghub
```

--------------------------------

### Animate Icons with Spin

Source: https://github.com/spyder-ide/qtawesome/blob/master/README.md

Apply a spinning animation to an icon. The animation can be controlled to start and stop as needed.

```python
# Spining icons
spin_button = QtWidgets.QPushButton(' Spinning icon')
animation = qta.Spin(spin_button)
spin_icon = qta.icon('fa5s.spinner', color='red', animation=animation)
spin_button.setIcon(spin_icon)

# Stop the animation when needed
animation.stop()

```

--------------------------------

### Commit Changes

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Commit your changes with a concise, imperative message. The message should be 74 characters or less, start with a capital letter, and end without a period.

```bash
git commit -am "Fix bug using custom font on Windows"
```

--------------------------------

### Create Wheel Package

Source: https://github.com/spyder-ide/qtawesome/blob/master/RELEASE.md

Builds a wheel package for the project using setup.py.

```bash
python setup.py bdist_wheel
```

--------------------------------

### Create Source Distribution

Source: https://github.com/spyder-ide/qtawesome/blob/master/RELEASE.md

Builds the source distribution (sdist) package for the project using setup.py.

```bash
python setup.py sdist
```

--------------------------------

### Update Codicons using setup.py

Source: https://github.com/spyder-ide/qtawesome/blob/master/UPDATE.md

Run this command to update the Codicons after checking the latest release and preparing the font files. Replace X.X.X with the actual latest version number.

```bash
python setup.py update_msc --msc-version X.X.X
```

--------------------------------

### Set Up Development Branch

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Use these commands to create a new feature branch based on the latest upstream changes. Ensure you replace placeholders with your specific branch names.

```bash
git checkout <BASE-BRANCH>
git pull upstream <BASE-BRANCH>
git checkout -b <FEATURE-BRANCH>
```

--------------------------------

### Display Icon as a widget

Source: https://github.com/spyder-ide/qtawesome/blob/master/docs/source/usage.md

Demonstrates creating animated and static icon widgets using qta.IconWidget.

```python
# -- Spinning icon widget
spin_widget = qta.IconWidget()
animation = qta.Spin(spin_widget)
spin_icon = qta.icon('mdi.loading', color='red', animation=animation)
spin_widget.setIcon(spin_icon)

# Stop animation when needed
animation.stop()

# -- Simple widget
simple_widget = qta.IconWidget('mdi.web', color='blue',
                               size=QtCore.QSize(16, 16))
```

--------------------------------

### Import QtAwesome

Source: https://github.com/spyder-ide/qtawesome/blob/master/docs/source/usage.md

Initial import required to access the library functionality.

```python
import qtawesome as qta
```

--------------------------------

### Clone the QtAwesome Repository

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Clone your forked repository to your local machine.

```bash
git clone <LINK-TO-YOUR-REPO>
```

--------------------------------

### Prepare for Release Commit

Source: https://github.com/spyder-ide/qtawesome/blob/master/RELEASE.md

Stages all changes and creates a commit to mark the release version, removing the 'dev0' suffix.

```bash
git add . && git commit -m "Release X.Y.Z"
```

--------------------------------

### Create Release Tag

Source: https://github.com/spyder-ide/qtawesome/blob/master/RELEASE.md

Creates an annotated Git tag for the release version.

```bash
git tag -a vX.Y.Z -m "Release X.Y.Z"
```

--------------------------------

### Prepare for Next Development Cycle

Source: https://github.com/spyder-ide/qtawesome/blob/master/RELEASE.md

Stages all changes and creates a commit to add the 'dev0' suffix and increment the minor version for the next development cycle.

```bash
git add . && git commit -m "Back to work"
```

--------------------------------

### Create Conda Environment

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Create a new Conda environment named 'qtawesome-env' with Python 3.9.

```bash
conda create -c conda-forge -n qtawesome-env python=3.9
```

--------------------------------

### Activate Conda Environment

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Activate the 'qtawesome-env' Conda environment.

```bash
conda activate qtawesome-env
```

--------------------------------

### Create venv Environment

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Create a virtual environment using Python's venv module.

```bash
python -m venv qtawesome-env
```

--------------------------------

### Activate venv Environment (Windows CMD)

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Activate the virtual environment on Windows using the Command Prompt.

```cmd
.\qtawesome-env\Scripts\activate.bat
```

--------------------------------

### Activate venv Environment (Linux/macOS)

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Activate the virtual environment on Linux or macOS.

```bash
source qtawesome-env/bin/activate
```

--------------------------------

### Run All Tests

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Execute the full test suite using Pytest. This command is recommended before committing changes to ensure code quality and stability.

```bash
pytest -vv -x
```

--------------------------------

### Upload to PyPI

Source: https://github.com/spyder-ide/qtawesome/blob/master/RELEASE.md

Uploads the generated distribution files to the Python Package Index (PyPI).

```bash
twine upload dist/*
```

--------------------------------

### Display Icons as Widgets

Source: https://github.com/spyder-ide/qtawesome/blob/master/README.md

Use QtAwesome's IconWidget to display icons directly as widgets. This includes support for animated icons and basic icon display with size and color options.

```python
# Spining icon widget
spin_widget = qta.IconWidget()
animation = qta.Spin(spin_widget, autostart=False)
spin_icon = qta.icon('mdi.loading', color='red', animation=animation)
spin_widget.setIcon(spin_icon)

# Simple icon widget
simple_widget = qta.IconWidget('mdi.web', color='blue', 
                               size=QtCore.QSize(16, 16))

# Start and stop the animation when needed
animation.start()
animation.stop()

```

--------------------------------

### Apply Built-in Animations to Icons

Source: https://github.com/spyder-ide/qtawesome/blob/master/docs/source/usage.md

Demonstrates various animation effects including spin, pulse, breathe, fade, heartbeat, swing, shake, elastic, color cycle, composite, and timed animations.

```python
# -- Spin animation (continuous rotation)
spin_button = QtWidgets.QPushButton(' Spinning icon')
animation = qta.Spin(spin_button, step=2, interval=10)
spin_icon = qta.icon('fa5s.spinner', color='red', animation=animation)
spin_button.setIcon(spin_icon)

# Stop animation when needed
animation.stop()

# -- Pulse animation (stepped rotation)
pulse_button = QtWidgets.QPushButton(' Pulsing icon')
animation = qta.Pulse(pulse_button, autostart=False)
pulse_icon = qta.icon('fa5s.spinner', color='green', animation=animation)
pulse_button.setIcon(pulse_icon)

# Start and stop the animation when needed
animation.start()
animation.stop()

# -- Breathe animation (scale pulsing)
breathe_button = QtWidgets.QPushButton(' Breathing icon')
animation = qta.Breathe(breathe_button, min_scale=0.8, max_scale=1.2, period=2000)
breathe_icon = qta.icon('fa5s.heart', color='red', animation=animation)
breathe_button.setIcon(breathe_icon)

# -- Fade animation (opacity pulsing)
fade_button = QtWidgets.QPushButton(' Fading icon')
animation = qta.Fade(fade_button, min_opacity=0.2, max_opacity=1.0, period=2000)
fade_icon = qta.icon('fa5s.lightbulb', color='orange', animation=animation)
fade_button.setIcon(fade_icon)

# -- HeartBeat animation (double pulse pattern)
heartbeat_button = QtWidgets.QPushButton(' Heartbeat')
animation = qta.HeartBeat(heartbeat_button, max_scale=1.3, period=1000)
heartbeat_icon = qta.icon('fa5s.heart', color='red', animation=animation)
heartbeat_button.setIcon(heartbeat_icon)

# -- Swing animation (pendulum motion)
swing_button = QtWidgets.QPushButton(' Swinging')
animation = qta.Swing(swing_button, angle=15, period=1000)
swing_icon = qta.icon('fa5s.bell', color='gold', animation=animation)
swing_button.setIcon(swing_icon)

# -- Shake animation (vibration)
shake_button = QtWidgets.QPushButton(' Shaking')
animation = qta.Shake(shake_button, amplitude_x=3, amplitude_y=3, period=200)
shake_icon = qta.icon('fa5s.bell', color='orange', animation=animation)
shake_button.setIcon(shake_icon)

# -- Elastic animation (bounce with overshoot)
elastic_button = QtWidgets.QPushButton(' Elastic')
animation = qta.Elastic(elastic_button, min_scale=0.5, max_scale=1.0, period=1500)
elastic_icon = qta.icon('fa5s.certificate', color='purple', animation=animation)
elastic_button.setIcon(elastic_icon)

# -- ColorCycle animation (cycle through colors)
color_button = QtWidgets.QPushButton(' Color Cycle')
animation = qta.ColorCycle(color_button, colors=['red', 'orange', 'yellow', 'green', 'blue'])
color_icon = qta.icon('fa5s.star', animation=animation)
color_button.setIcon(color_icon)

# -- CompositeAnimation (combine multiple effects)
composite_button = QtWidgets.QPushButton(' Composite')
anim1 = qta.Spin(composite_button, step=2, autostart=False)
anim2 = qta.Breathe(composite_button, min_scale=0.8, max_scale=1.2, autostart=False)
animation = qta.CompositeAnimation(composite_button, [anim1, anim2])
composite_icon = qta.icon('fa5s.star', color='orange', animation=animation)
composite_button.setIcon(composite_icon)

# -- Animation with duration (auto-stops after time)
duration_button = QtWidgets.QPushButton(' Timed animation')
animation = qta.Spin(duration_button, duration=3000)  # Stops after 3 seconds
duration_icon = qta.icon('fa5s.hourglass', animation=animation)
duration_button.setIcon(duration_icon)

# -- Stacked spin icons
stack_spin_button = QtWidgets.QPushButton('Stack spin')
animation = qta.Spin(stack_spin_button)
options = [{'scale_factor': 0.4,
            'animation': animation},
            {'color': 'blue'}]
stack_spin_icon = qta.icon('ei.asl', 'fa5.square',
                           options=options)
stack_spin_button.setIcon(stack_spin_icon)
stack_spin_button.setIconSize(QtCore.QSize(32, 32))
```

--------------------------------

### Load Icons by Name

Source: https://github.com/spyder-ide/qtawesome/blob/master/docs/source/usage.md

Retrieve icons from various supported libraries like Font Awesome, Material Design, and others by their identifier.

```python
# Get FontAwesome 6.x icons by name in various styles:
fa6_icon = qta.icon('fa6.flag')
fa6_button = QtWidgets.QPushButton(fa6_icon, 'Font Awesome 6! (regular)')

fa6s_icon = qta.icon('fa6s.flag')
fa6s_button = QtWidgets.QPushButton(fa6s_icon, 'Font Awesome 6! (solid)')

fa6b_icon = qta.icon('fa6b.github')
fa6b_button = QtWidgets.QPushButton(fa6b_icon, 'Font Awesome 6! (brands)')

# Get FontAwesome 5.x icons by name in various styles:
fa5_icon = qta.icon('fa5.flag')
fa5_button = QtWidgets.QPushButton(fa5_icon, 'Font Awesome 5! (regular)')

fa5s_icon = qta.icon('fa5s.flag')
fa5s_button = QtWidgets.QPushButton(fa5s_icon, 'Font Awesome 5! (solid)')

fa5b_icon = qta.icon('fa5b.github')
fa5b_button = QtWidgets.QPushButton(fa5b_icon, 'Font Awesome 5! (brands)')

# Get Elusive icons by name
asl_icon = qta.icon('ei.asl')
elusive_button = QtWidgets.QPushButton(asl_icon, 'Elusive Icons!')

# Get Material Design icons 6.x by name
apn_icon = qta.icon('mdi6.access-point-network')
mdi6_button = QtWidgets.QPushButton(apn_icon, 'Material Design Icons!')

# Get Phosphor by name
mic_icon = qta.icon('ph.microphone-fill')
ph_button = QtWidgets.QPushButton(mic_icon, 'Phosphor!')

# Get Remix Icon by name
truck_icon = qta.icon('ri.truck-fill')
ri_button = QtWidgets.QPushButton(truck_icon, 'Remix Icon!')

# Get Microsoft's Codicons by name
squirrel_icon = qta.icon('msc.squirrel')
msc_button = QtWidgets.QPushButton(squirrel_icon, 'Codicons!')
```

--------------------------------

### Apply font label rendering

Source: https://github.com/spyder-ide/qtawesome/blob/master/docs/source/usage.md

Renders a QLabel using a specific font icon from the QtAwesome library.

```python
# Render a label with this font
label = QtWidgets.QLabel(unichr(0xf19c) + ' ' + 'Label')
label.setFont(qta.font('fa', 16))
```

--------------------------------

### Apply Styling to Icons

Source: https://github.com/spyder-ide/qtawesome/blob/master/README.md

Customize the appearance of icons by setting active and inactive colors, and applying different styles for active states.

```python
# Styling icons
styling_icon = qta.icon('fa5s.music',
                        active='fa5s.balance-scale',
                        color='blue',
                        color_active='orange')
music_button = QtWidgets.QPushButton(styling_icon, 'Styling')

```

--------------------------------

### Draw Icons as Images

Source: https://github.com/spyder-ide/qtawesome/blob/master/docs/source/usage.md

Specify the drawing method using the options parameter.

```python
# Icon drawn with the `image` option
drawn_image_icon = qta.icon('ri.truck-fill',
                         options=[{'draw': 'image'}])
drawn_image_button = QtWidgets.QPushButton(drawn_image_icon,
                                           'Icon drawn as an image')
```

--------------------------------

### Set Upstream Remote

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Add the official QtAwesome repository as an upstream remote.

```bash
git remote add upstream https://github.com/spyder-ide/qtawesome.git
```

--------------------------------

### Check Distribution Files

Source: https://github.com/spyder-ide/qtawesome/blob/master/RELEASE.md

Validates the generated distribution files in the 'dist' directory using Twine.

```bash
twine check dist/*
```

--------------------------------

### Apply Toggling State Styling

Source: https://github.com/spyder-ide/qtawesome/blob/master/docs/source/usage.md

Configure icons to change appearance based on the widget's checkable state.

```python
# Toggle
toggle_icon = qta.icon('fa5s.home', selected='fa5s.balance-scale',
                        color_off='black',
                        color_off_active='blue',
                        color_on='orange',
                        color_on_active='yellow')
toggle_button = QtWidgets.QPushButton(toggle_icon, 'Toggle')
toggle_button.setCheckable(True)
```

--------------------------------

### Apply Icon Transformations

Source: https://github.com/spyder-ide/qtawesome/blob/master/docs/source/usage.md

Rotate or flip icons using keyword arguments during icon creation.

```python
# Rotated
rot_icon = qta.icon('mdi.access-point-network', rotated=45)
rot_button = QtWidgets.QPushButton(rot_icon, 'Rotated Icons!')

# Horizontal flip
hflip_icon = qta.icon('mdi.account-alert', hflip=True)
hflip_button = QtWidgets.QPushButton(hflip_icon, 'Horizontally Flipped Icons!')

# Vertical flip
vflip_icon = qta.icon('mdi.account-alert', vflip=True)
vflip_button = QtWidgets.QPushButton(vflip_icon, 'Vertically Flipped Icons!')
```

--------------------------------

### Automate Remix Icon Update Script

Source: https://github.com/spyder-ide/qtawesome/blob/master/UPDATE.md

This script downloads the latest TTF font and CSS file, calculates the MD5 hash of the TTF, generates a JSON charmap, and prints the hash. Update the VERSION, TTF_URL, and CSS_URL variables as needed.

```Python
import re
import json
import urllib.request
import hashlib

VERSION = '2.5.0'  # Update version as required
TTF_URL = 'https://raw.githubusercontent.com/Remix-Design/RemixIcon/master/fonts/remixicon.ttf'
CSS_URL = 'https://raw.githubusercontent.com/Remix-Design/RemixIcon/master/fonts/remixicon.css'
FONT_FILENAME = 'remixicon-{version}.ttf'.format(version=VERSION)
FONT_CHARMAP_FILENAME = "remixicon-charmap-{version}.json".format(
    version=VERSION
)

with open(FONT_FILENAME, 'wb') as fp:
    req = urllib.request.urlopen(TTF_URL)
    if req.status != 200:
        raise Exception('Failed to download TTF')
    fp.write(req.read())
    req.close()

hasher = hashlib.md5()
with open(FONT_FILENAME, 'rb') as f:
    content = f.read()
    hasher.update(content)

ttf_calculated_hash_code = hasher.hexdigest()
print('MD5 :', ttf_calculated_hash_code)

req = urllib.request.urlopen(CSS_URL)
if req.status != 200:
    raise Exception('Failed to download CSS Charmap')

rawcss = req.read().decode()
req.close()

charmap = {}
pattern = '^\.ri-(.+):before {\s*content: "(.+)";\s*}$'
data = re.findall(pattern, rawcss, re.MULTILINE)
for name, key in data:
    key = key.replace('\\', '0x')
    name = name.lower()
    charmap[name] = key

with open(FONT_CHARMAP_FILENAME, 'w') as fp:
    json.dump(charmap, fp, indent=4, sort_keys=True)

```

--------------------------------

### Define Icon Drawing Method

Source: https://github.com/spyder-ide/qtawesome/blob/master/README.md

Specify how an icon should be rendered using different drawing methods like 'image'. The default methods are 'text' and 'path'.

```python
# Icon drawn with the `image` option
drawn_image_icon = qta.icon('ri.truck-fill',
                            options=[{'draw': 'image'}])
drawn_image_button = QtWidgets.QPushButton(drawn_image_icon,
                                           'Icon drawn as an image')

```

--------------------------------

### Update Changelog

Source: https://github.com/spyder-ide/qtawesome/blob/master/RELEASE.md

Updates the CHANGELOG.md file by fetching release information from GitHub based on the specified version.

```bash
loghub spyder-ide/qtawesome -m vX.Y.Z
```

--------------------------------

### Create Custom Animations

Source: https://github.com/spyder-ide/qtawesome/blob/master/docs/source/usage.md

Implement a custom animation class by inheriting from BaseAnimation and overriding state update and transformation methods.

```python
# Import utility functions for common patterns
from qtawesome.animation import BaseAnimation, _sine_wave_value

# Define your custom animation class
class MyWobbleAnimation(BaseAnimation):
    """Custom wobble animation that moves icon horizontally."""

    def __init__(self, parent_widget, wobble_amount=10, period=1000, **kwargs):
        super().__init__(parent_widget, **kwargs)
        self.wobble_amount = wobble_amount
        self.period = period

    def _get_initial_state(self):
        return {'offset': 0}

    def _update_animation_state(self, elapsed, state):
        # Use utility function for sine wave oscillation
        state['offset'] = _sine_wave_value(
            elapsed, self.period, -self.wobble_amount, self.wobble_amount
        )

    def _apply_transform(self, icon_painter, painter, rect, state):
        # Apply horizontal translation
        painter.translate(state['offset'], 0)

# Use your custom animation
wobble_button = QtWidgets.QPushButton(' Custom Wobble')
animation = MyWobbleAnimation(wobble_button, wobble_amount=15, period=800)
wobble_icon = qta.icon('fa5s.star', color='purple', animation=animation)
wobble_button.setIcon(wobble_icon)
```

--------------------------------

### Stack Multiple Icons

Source: https://github.com/spyder-ide/qtawesome/blob/master/README.md

Combine multiple icons into a single icon, allowing for layered effects and custom positioning. Options can be provided to scale and color individual stacked icons.

```python
# Stacking icons
camera_ban = qta.icon('fa5s.camera', 'fa5s.ban',
                      options=[{'scale_factor': 0.5,
                                'active': 'fa5s.balance-scale'},
                               {'color': 'red'}])
stack_button = QtWidgets.QPushButton(camera_ban, 'Stack')
stack_button.setIconSize(QtCore.QSize(32, 32))

```

--------------------------------

### Update Material Design Icons

Source: https://github.com/spyder-ide/qtawesome/blob/master/UPDATE.md

This script automates the download of the latest TTF font and CSS for Material Design Icons, generates a JSON charmap, and calculates the MD5 hash of the TTF file. It requires manual updates to the version number.

```Python
import re
import json
import urllib.request
import hashlib


VERSION = '6.9.96'  # Update version as required
TTF_URL = 'https://raw.githubusercontent.com/Templarian/MaterialDesign-Webfont/master/fonts/materialdesignicons-webfont.ttf'
CSS_URL = 'https://raw.githubusercontent.com/Templarian/MaterialDesign-Webfont/master/css/materialdesignicons.css'
FONT_FILENAME = "materialdesignicons6-webfont-{version}.ttf".format(
    version=VERSION
)
FONT_CHARMAP_FILENAME = (
    "materialdesignicons6-webfont-charmap-{version}.json".format(
        version=VERSION
    )
)


with open(FONT_FILENAME, 'wb') as fp:
    req = urllib.request.urlopen(TTF_URL)
    if req.status != 200:
        raise Exception('Failed to download TTF')
    fp.write(req.read())
    req.close()

hasher = hashlib.md5()
with open(FONT_FILENAME, 'rb') as f:
    content = f.read()
    hasher.update(content)

ttf_calculated_hash_code = hasher.hexdigest()
print('MD5 :', ttf_calculated_hash_code)

req = urllib.request.urlopen(CSS_URL)
if req.status != 200:
    raise Exception('Failed to download CSS Charmap')

rawcss = req.read().decode()
req.close()

charmap = {}
pattern = '^\.mdi-(.+)::before {\s*content: "(.+)";\s*}$'
data = re.findall(pattern, rawcss, re.MULTILINE)
for name, key in data:
    key = key.replace('\F', '0xf').lower()
    key = key.replace('\', '0x')
    name = name.lower()
    charmap[name] = key

with open(FONT_CHARMAP_FILENAME, 'w') as fp:
    json.dump(charmap, fp, indent=4, sort_keys=True)
```

--------------------------------

### Automated Phosphor Icon Update Script

Source: https://github.com/spyder-ide/qtawesome/blob/master/UPDATE.md

This script automates downloading the latest TTF font, generating the JSON charmap, and printing the MD5 hash of the TTF file. Update the VERSION variable as needed. Ensure the script is run in an environment with internet access.

```Python
import re
import json
import urllib.request
import hashlib

VERSION = '1.3.0'  # Update version as required
TTF_URL = 'https://raw.githubusercontent.com/phosphor-icons/phosphor-icons/master/src/font/phosphor.ttf'
CSS_URL = 'https://raw.githubusercontent.com/phosphor-icons/phosphor-icons/master/src/css/phosphor.css'
FONT_FILENAME = 'phosphor-{version}.ttf'.format(version=VERSION)
FONT_CHARMAP_FILENAME = "phosphor-charmap-{version}.json".format(
    version=VERSION
)

with open(FONT_FILENAME, 'wb') as fp:
    req = urllib.request.urlopen(TTF_URL)
    if req.status != 200:
        raise Exception('Failed to download TTF')
    fp.write(req.read())
    req.close()

hasher = hashlib.md5()
with open(FONT_FILENAME, 'rb') as f:
    content = f.read()
    hasher.update(content)

ttf_calculated_hash_code = hasher.hexdigest()
print('MD5 :', ttf_calculated_hash_code)

req = urllib.request.urlopen(CSS_URL)
if req.status != 200:
    raise Exception('Failed to download CSS Charmap')

rawcss = req.read().decode()
req.close()

charmap = {}
pattern = '^\.ph-(.+):before {\s*content: "(.+)";\s*}$'
data = re.findall(pattern, rawcss, re.MULTILINE)
for name, key in data:
    key = key.replace('\\', '0x')
    name = name.lower()
    charmap[name] = key

with open(FONT_CHARMAP_FILENAME, 'w') as fp:
    json.dump(charmap, fp, indent=4, sort_keys=True)


```

--------------------------------

### Push Changes and Tags

Source: https://github.com/spyder-ide/qtawesome/blob/master/RELEASE.md

Pushes the local master branch and all tags to the upstream remote repository.

```bash
git push upstream master && git push upstream --tags
```

--------------------------------

### Clean Local Repository

Source: https://github.com/spyder-ide/qtawesome/blob/master/RELEASE.md

Removes untracked files and directories from the local repository, selecting option 1 for a thorough clean.

```bash
git clean -xfdi
```

--------------------------------

### Push Changes to Remote Fork

Source: https://github.com/spyder-ide/qtawesome/blob/master/CONTRIBUTING.md

Push your feature branch to your personal fork on the remote repository. Replace <FEATURE-BRANCH> with the actual name of your branch.

```bash
git push -u origin <FEATURE-BRANCH>
```

--------------------------------

### Update Local Repository

Source: https://github.com/spyder-ide/qtawesome/blob/master/RELEASE.md

Fetches the latest changes from the upstream repository and merges them into the local master branch.

```bash
git fetch upstream && git checkout master && git merge upstream/master
```

--------------------------------

### Set Icon Alpha Transparency

Source: https://github.com/spyder-ide/qtawesome/blob/master/README.md

Control the transparency of an icon's color by specifying an alpha value between 0 and 255.

```python
# Setting an alpha of 120 to the color of this icon. Alpha must be a number
# between 0 and 255.
icon_with_alpha = qta.icon('mdi.heart',
                           color=('red', 120))
heart_button = QtWidgets.QPushButton(icon_with_alpha, 'Setting alpha')

```

--------------------------------

### Generate Elusive Icons Charmap

Source: https://github.com/spyder-ide/qtawesome/blob/master/UPDATE.md

This script regenerates the JSON charmap for Elusive Icons from an icons.yml file. It handles icon IDs, aliases, and outputs a sorted JSON file.

```Python
import yaml, json

with open('icons.yml', 'r') as file:
    icons = yaml.load(file)['icons']

charmap = {icon['id']: icon['unicode'] for icon in icons}

for icon in icons:
    if 'aliases' in icon:
        for name in icon['aliases']:
            charmap[name] = icon['unicode']

with open('charmap.json', 'w') as file:
    json.dump(charmap, file, indent=4, sort_keys=True)
```
Tokens:
Raw