# tkfeather <img src="tkfeather-white.svg" width=48>
#### tkinter support for [feather icons](https://feathericons.com)
## Latest Changes
Current version: 1.0.0-rc1
- Initial release
## Usage
### Import
`from tkfeather import Feather`
Initialization:
`Feather(name: str, size: int [optional])`
### Args
- `name: str` - The name of the Feather icon
- `size: int [optional]` - The size of the icon image in pixels, square
(default: 24)
> Note: Sizes smaller than 24px are allowed but aren't recommended as the
icon will become blurred
>
> The minimum allowed `size` is 1, and the maximum allowed `size` is 1024
### Properties
- `Feather.icon` - an `ImageTk.PhotoImage` object for the given Feather
icon
### Class Methods
- `Feather.icons_available()` returns a list with the names of all
available Feather Icons
### Exceptions
- Passing a `size` value outside the range of 1 to 1024 will raise a
`ValueError`
- Trying to use an icon that doesn't exist will raise a `FileNotFoundError`
### Example
You must maintain a reference to the Feather instance in a variable in
order to keep the image from being garbage-collected:
```python
# this works
feather = Feather('home')
label = tk.Label(parent, image=feather.icon)
label.pack()
```
If you don't maintain a reference to the image, it won't appear!
```python
# this doesn't work - the label will have no image
label = tk.Label(parent, image=Feather('home').icon)
label.pack()
```
### Installation
`pip install tkfeather`
### Packaged Dependencies
- PNG Icons
- Pillow >= 9.2.0
##
### Acknowledgements
Based on **Feather Icons** originally created by Cole Bemis
- https://feathericons.com
- https://github.com/feathericons/feather
Under MIT License
Raw data
{
"_id": null,
"home_page": "https://github.com/JRiggles/tkfeather",
"name": "tkfeather",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": "tkinter, icons, Feather",
"author": "John Riggles",
"author_email": "jriggles@icloud.com",
"download_url": "https://files.pythonhosted.org/packages/15/73/1f97876a26c14edf51edb5cbd292b311e5ebf7a1bde27099ee33e17ee11d/tkfeather-1.0.0.tar.gz",
"platform": null,
"description": "# tkfeather <img src=\"tkfeather-white.svg\" width=48>\n\n#### tkinter support for [feather icons](https://feathericons.com)\n\n## Latest Changes\nCurrent version: 1.0.0-rc1\n\n- Initial release\n\n## Usage\n\n### Import\n\n`from tkfeather import Feather`\n\nInitialization:\n\n`Feather(name: str, size: int [optional])`\n\n### Args\n- `name: str` - The name of the Feather icon\n- `size: int [optional]` - The size of the icon image in pixels, square\n(default: 24)\n\n> Note: Sizes smaller than 24px are allowed but aren't recommended as the\nicon will become blurred\n>\n> The minimum allowed `size` is 1, and the maximum allowed `size` is 1024\n\n### Properties\n- `Feather.icon` - an `ImageTk.PhotoImage` object for the given Feather\nicon\n\n### Class Methods\n- `Feather.icons_available()` returns a list with the names of all\navailable Feather Icons\n\n### Exceptions\n- Passing a `size` value outside the range of 1 to 1024 will raise a\n`ValueError`\n- Trying to use an icon that doesn't exist will raise a `FileNotFoundError`\n\n### Example\nYou must maintain a reference to the Feather instance in a variable in\norder to keep the image from being garbage-collected:\n\n```python\n# this works\nfeather = Feather('home')\nlabel = tk.Label(parent, image=feather.icon)\nlabel.pack()\n```\n\nIf you don't maintain a reference to the image, it won't appear!\n\n```python\n# this doesn't work - the label will have no image\nlabel = tk.Label(parent, image=Feather('home').icon)\nlabel.pack()\n```\n\n### Installation\n\n`pip install tkfeather`\n\n### Packaged Dependencies\n\n- PNG Icons\n- Pillow >= 9.2.0\n\n##\n\n### Acknowledgements\n\nBased on **Feather Icons** originally created by Cole Bemis\n\n- https://feathericons.com\n- https://github.com/feathericons/feather\n\nUnder MIT License\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Feather icons for tkinter",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/JRiggles/tkfeather",
"Repository": "https://github.com/JRiggles/tkfeather"
},
"split_keywords": [
"tkinter",
" icons",
" feather"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bf4ea99d77f96a0eafa270bc186462bc22746eea37876d913f4ebdf6cc17852d",
"md5": "ae8f7bb71e17e28314b4ec040e0cbc12",
"sha256": "40c0e40699b76fa54cb5c32d1d1756d7a3a9f1d4f15e9095d20237d4a554696f"
},
"downloads": -1,
"filename": "tkfeather-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae8f7bb71e17e28314b4ec040e0cbc12",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 5229215,
"upload_time": "2024-06-08T00:18:01",
"upload_time_iso_8601": "2024-06-08T00:18:01.568032Z",
"url": "https://files.pythonhosted.org/packages/bf/4e/a99d77f96a0eafa270bc186462bc22746eea37876d913f4ebdf6cc17852d/tkfeather-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "15731f97876a26c14edf51edb5cbd292b311e5ebf7a1bde27099ee33e17ee11d",
"md5": "3d31c189d066d316d3b281597fc36c48",
"sha256": "9aa64a9082febf532b9e9f598276351bff3e24e34b152ea513d7738890e62bd0"
},
"downloads": -1,
"filename": "tkfeather-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3d31c189d066d316d3b281597fc36c48",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 5185534,
"upload_time": "2024-06-08T00:18:06",
"upload_time_iso_8601": "2024-06-08T00:18:06.513832Z",
"url": "https://files.pythonhosted.org/packages/15/73/1f97876a26c14edf51edb5cbd292b311e5ebf7a1bde27099ee33e17ee11d/tkfeather-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-08 00:18:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JRiggles",
"github_project": "tkfeather",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "tkfeather"
}
JSON
