Metadata-Version: 2.1
Name: pytkfaicons
Version: 0.0.8
Summary: tkinter fontawesome icons
Home-page: https://github.com/kr-g/pytkfaicons
Author: k. goger
Author-email: k.r.goger+pytkfaicons@gmail.com
License: others
Keywords: python tkinter fontawesome icons svg fonts
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.md

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

# pytkfaicons 

fontawesome font based icons support for tkinter

uses font-awesome version==6.3.0

NOTE: this version is used on the rolling baseline, refer to the corresponding tagged README


# what's new ?

check
[`CHANGELOG`](https://github.com/kr-g/pytkfaicons/blob/main/CHANGELOG.md)
for latest ongoing, or upcoming news 

for known issues, limitations and backlog refer to 
[`BACKLOG`](https://github.com/kr-g/pytkfaicons/blob/main/BACKLOG.md)

# sample screenshot

<img src="screenshot.png" />

# platform

tested on python3 and linux


## development status

alpha state.
the API or logical call flow might change without prior notice.

in case your code breaks between two versions check
[`CHANGELOG`](https://github.com/kr-g/pytkfaicons/blob/main/CHANGELOG.md)
information first before creating a ticket / issue on github. thanks.


# note on self-build a local package 

- for downloading content from github with 
[`pygitrab`](https://github.com/kr-g/pygitgrab) 
a credits file is required.


# installation
    
      python3 -m pip install pytkfaicons


## installation on raspberry pi

here it might be required (in some cases) to install imagetk in addtion

    sudo apt-get install python3-pil python3-pil.imagetk


# license

refer to https://github.com/kr-g/pytkfaicons/blob/main/LICENSE.md

and

[Font-Awesome](https://github.com/FortAwesome/Font-Awesome/tree/master)





# Changelog

for known issues and backlog refer to 
[`BACKLOG`](https://github.com/kr-g/pytkfaicons/blob/main/BACKLOG.md)


check also [fa-changelog](https://fontawesome.com/docs/changelog/)


## version v0.0.8 - 20230225

- changed folder structure
- fa v6.2.1
- icon alias name support
- font caching
- 


## version v0.0.7 - 20220729

- bug fix, dur to corrupted local env
- 


## version v0.0.6 - 20220729

- bug fix, dur to corrupted local env
- 


## version v0.0.5 - 20220729

- bump python version >= 3.8
- 


## version v0.0.4 - 20220729

- droped drepracted image from svg generation
  - only font images are supported from now 
- changed fonts folder layout
- 


## version v0.0.3

- added color support for scalable icons  
- fix build
- added font based icons
- 


## version v0.0.2

- added scalable icons support 
- refactored package structure
- reduced initial download since using json svg for rendering directly
- 


## version v0.0.1

- first version



# BACKLOG


# known issues 
- 


# backlog

- ~~rework design, font as main basis~~
  - ~~set to deprecated~~
    - ~~image from svg generation~~
    - ~~remove wand dependency~~
- ~~add install Pillow with pip to setup.py/setuptools~~
- ~~font support for https://github.com/FortAwesome/Font-Awesome/tree/master/otfs~~
  - for integration refer to:
    - https://github.com/fonttools/fonttools
    - https://pillow.readthedocs.io/en/stable/reference/ImageFont.html
- ~~font support for *.ttf under https://github.com/FortAwesome/Font-Awesome/tree/master/webfonts~~
- ~~refactor code into class builder based icon creation~~
- refactor code base 
- 


(c) 2021, 2022, 2023 k. goger - https://github.com/kr-g
https://github.com/kr-g/pytkfaicons


license information:

fontawesome : 
refer to https://github.com/FortAwesome/Font-Awesome

pytkfaicons : 
GNU AFFERO GENERAL PUBLIC LICENSE version 3 and later
https://www.gnu.org/licenses/agpl-3.0.en.html





