Skip to content

Latest commit

 

History

History
173 lines (116 loc) · 5.93 KB

README.md

File metadata and controls

173 lines (116 loc) · 5.93 KB
Raw

Tabler QIcon

GitHub GitHub Repo PyPI Version

Tabler QIcon is a Python package that provides easy access to Tabler Icons [Preview] [GitHub] for PyQt and PySide applications. It uses SVGs from Tabler Icons and converts them into QIcon objects, which can be used in PyQt and PySide applications.

This package also supports icon customization such as changing color, size, view box size, stroke width, opacity, and applying transformations like flip and flop.

Tabler QIcon v0.3.0 is currently synced with tabler-icons version 3.0. Please refer to the update.log file for more details on the last sync.

Preview icons

Tabler Icons

🚀 Features

  • Customizable Icons: Adjust color, size, view box size, stroke width, opacity, and apply transformations like flip and flop.
  • Developer-Friendly: Python stubs enhance code autocompletion and type-checking in your IDE. Code Autocompletion Code Autocompletion
  • Broad Compatibility: Supports PyQt5, PyQt6, PySide2, and PySide6.
  • Transformation Features: Flip and flop transformations can be applied to icons easily. (introduced in v0.2.2)

📋 Prerequisites

  • Python 3.7 or later
  • One of the following: PyQt5, PyQt6, PySide2, or PySide6

💻 Installation

You can install tabler-qicon from PyPI using pip:

pip install tabler-qicon

Alternatively, you can install it directly from the GitHub repository:

pip install git+https://github.com/promto-c/tabler-qicon.git

Using PyQt5? Install it separately:

pip install PyQt5

🖌️ Usage

Setting the Backend

Using Environment Variables (with qtpy)

If you're using qtpy to maintain compatibility across different PyQt/PySide backends, you'll need to specify the backend before importing other modules:

import os
os.environ['QT_API'] = 'PyQt5'  # Change 'PyQt5' to your desired backend

from tablerqicon import TablerQIcon

# ... Additional code ...

Using the use_backend method

Alternatively, you can also set the backend directly using the use_backend method:

import tablerqicon
tablerqicon.use_backend('PyQt5')

from tablerqicon import TablerQIcon

# ... Additional code ...

Default Usage

Directly access icons with default properties:

from PyQt5 import QtWidgets
from tablerqicon import TablerQIcon

# ... Additional code ...

refresh_button = QtWidgets.QPushButton("Refresh")

# Set the QIcon for the refresh_button using the 'refresh' icon name as an attribute
refresh_button.setIcon(TablerQIcon.refresh)

Customized Icons

  1. Instantiate TablerQIcon with your desired properties.
  2. Access icons using icon names.
  3. Utilize flip and flop transformations for versatile usage of icons.
from PyQt5 import QtWidgets
from tablerqicon import TablerQIcon

# ... Additional code ...

# Example: Using a custom opacity
tabler_icon = TablerQIcon(opacity=0.6)

refresh_button = QtWidgets.QPushButton('Refresh')
word_wrap_button = QtWidgets.QPushButton('Word Wrap')
play_backward_button = QtWidgets.QPushButton('Play Backward')

# Set the QIcon for the refresh_button using the 'refresh' icon name as an attribute
refresh_button.setIcon(tabler_icon.refresh)
# Set the QIcon for the word_wrap_button using the 'text_wrap' icon name as an attribute
word_wrap_button.setIcon(tabler_icon.text_wrap)
# Applying flip and flop transformations before setting the icon
play_backward_button.setIcon(tabler_icon.flip.flop.player_play)

Retrieve All Icon Names

print(TablerQIcon.get_icon_names())

🛠️ Development

Syncing Icons

To sync icons, we use a shell script that clones the icons from the tabler-icons repository and generates a .pyi file to facilitate type hints and autocompletion in IDEs.

If you are a contributor or a developer working on this project and need to sync icons, follow the steps below:

  1. Run the Sync Script:

    ./sync_tabler_icons.sh

    This script will:

    • Clone the latest icons from the tabler-icons repository.
    • Copy the icons to the target directory.
    • Generate a .pyi file to facilitate type hints and autocompletion.

  2. Check the Update Log: After running the script, check the update.log file in the icons directory to ensure that the sync was successful and to view details of the sync.

  3. Commit Changes: After successfully syncing the icons and generating the .pyi file, commit these changes to the version control system.

Note to Contributors

  • Please do not edit the generated .pyi file directly. It is auto-generated by the sync script.
  • Ensure that you have run the sync script and tested the changes locally before submitting a pull request.

Running Tests

Run the tests to ensure that your changes do not break existing functionality.

pytest tests

🖋️ Coding Style

Adhering to PEP 8 with flake8 oversight. Auto-formatting via yapf. Our docstrings embrace the Google Python Style Guide for clarity and consistency.

📜 License

Tabler QIcon is licensed under the MIT License.

Note: This README.md file was generated by ChatGPT.