# fa6-icons
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
This module provides the free icons from [Font
Awesome](https://fontawesome.com/) v6 in a python-friendly form.
The actual SVGs and associated data are licensed on the same terms as
the originals – this package only adds a little on top to make them
easier to use from Python.
## Install
``` sh
pip install fa6_icons
```
…or…
``` sh
conda install -c fastai fa6_icons
```
## How to use
Two objects are provided, `svgs` and `dims`.
``` python
from fa6_icons import svgs,dims
```
These are both [AttrDict](https://fastcore.fast.ai/basics.html#attrdict)
objects, which behave as dicts, but can also be accessed with
dotted-attrs. They contain the same keys. To search them, use standard
python dict approaches, e.g:
``` python
[o for o in svgs if 'addr' in o]
```
['address_book', 'address_card']
Each style is available as a key for each SVG and dims entry, e.g:
``` python
dims.address_card
```
``` json
{'regular': (512, 576), 'solid': (512, 576)}
```
In a notebook environment, SVGs are displayed:
``` python
svgs.address_card.regular
```
<div style="max-width: 150px; width: 100%;"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path d="M512 80c8.8 0 16 7.2 16 16l0 320c0 8.8-7.2 16-16 16L64 432c-8.8 0-16-7.2-16-16L48 96c0-8.8 7.2-16 16-16l448 0zM64 32C28.7 32 0 60.7 0 96L0 416c0 35.3 28.7 64 64 64l448 0c35.3 0 64-28.7 64-64l0-320c0-35.3-28.7-64-64-64L64 32zM208 256a64 64 0 1 0 0-128 64 64 0 1 0 0 128zm-32 32c-44.2 0-80 35.8-80 80c0 8.8 7.2 16 16 16l192 0c8.8 0 16-7.2 16-16c0-44.2-35.8-80-80-80l-64 0zM376 144c-13.3 0-24 10.7-24 24s10.7 24 24 24l80 0c13.3 0 24-10.7 24-24s-10.7-24-24-24l-80 0zm0 96c-13.3 0-24 10.7-24 24s10.7 24 24 24l80 0c13.3 0 24-10.7 24-24s-10.7-24-24-24l-80 0z"/></svg></div>
To make attr access more convenient, hyphens are replaced with
underscores, and icon names starting with a digit are prefixed with an
underscore.
Use `width` to view the svg in a notebook with a different width (it
defaults to 300px).
``` python
svgs._9.solid.width(25)
```
<div style="max-width: 25px; width: 100%;"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><path d="M64 192a96 96 0 1 0 192 0A96 96 0 1 0 64 192zm87.5 159.8C67.1 347.4 0 277.5 0 192C0 103.6 71.6 32 160 32s160 71.6 160 160c0 2.6-.1 5.3-.2 7.9c-1.7 35.7-15.2 70-38.4 97.4l-145 171.4c-11.4 13.5-31.6 15.2-45.1 3.8s-15.2-31.6-3.8-45.1l63.9-75.6z"/></svg></div>
When stringified, the SVG text is returned:
``` python
print(svgs._9.solid)
```
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><path d="M64 192a96 96 0 1 0 192 0A96 96 0 1 0 64 192zm87.5 159.8C67.1 347.4 0 277.5 0 192C0 103.6 71.6 32 160 32s160 71.6 160 160c0 2.6-.1 5.3-.2 7.9c-1.7 35.7-15.2 70-38.4 97.4l-145 171.4c-11.4 13.5-31.6 15.2-45.1 3.8s-15.2-31.6-3.8-45.1l63.9-75.6z"/></svg>
Raw data
{
"_id": null,
"home_page": "https://github.com/AnswerDotAI/fa6-icons",
"name": "fa6-icons",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "nbdev jupyter notebook python",
"author": "Jeremy Howard",
"author_email": "github@jhoward.fastmail.fm",
"download_url": "https://files.pythonhosted.org/packages/24/23/ef93c1c8b26ccbcfcf203d2026b703238eaadf92d428462ca69c1ede4cf0/fa6-icons-0.0.2.tar.gz",
"platform": null,
"description": "# fa6-icons\n\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\nThis module provides the free icons from [Font\nAwesome](https://fontawesome.com/) v6 in a python-friendly form.\n\nThe actual SVGs and associated data are licensed on the same terms as\nthe originals \u2013 this package only adds a little on top to make them\neasier to use from Python.\n\n## Install\n\n``` sh\npip install fa6_icons\n```\n\n\u2026or\u2026\n\n``` sh\nconda install -c fastai fa6_icons\n```\n\n## How to use\n\nTwo objects are provided, `svgs` and `dims`.\n\n``` python\nfrom fa6_icons import svgs,dims\n```\n\nThese are both [AttrDict](https://fastcore.fast.ai/basics.html#attrdict)\nobjects, which behave as dicts, but can also be accessed with\ndotted-attrs. They contain the same keys. To search them, use standard\npython dict approaches, e.g:\n\n``` python\n[o for o in svgs if 'addr' in o]\n```\n\n ['address_book', 'address_card']\n\nEach style is available as a key for each SVG and dims entry, e.g:\n\n``` python\ndims.address_card\n```\n\n``` json\n{'regular': (512, 576), 'solid': (512, 576)}\n```\n\nIn a notebook environment, SVGs are displayed:\n\n``` python\nsvgs.address_card.regular\n```\n\n<div style=\"max-width: 150px; width: 100%;\"><svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 576 512\"><path d=\"M512 80c8.8 0 16 7.2 16 16l0 320c0 8.8-7.2 16-16 16L64 432c-8.8 0-16-7.2-16-16L48 96c0-8.8 7.2-16 16-16l448 0zM64 32C28.7 32 0 60.7 0 96L0 416c0 35.3 28.7 64 64 64l448 0c35.3 0 64-28.7 64-64l0-320c0-35.3-28.7-64-64-64L64 32zM208 256a64 64 0 1 0 0-128 64 64 0 1 0 0 128zm-32 32c-44.2 0-80 35.8-80 80c0 8.8 7.2 16 16 16l192 0c8.8 0 16-7.2 16-16c0-44.2-35.8-80-80-80l-64 0zM376 144c-13.3 0-24 10.7-24 24s10.7 24 24 24l80 0c13.3 0 24-10.7 24-24s-10.7-24-24-24l-80 0zm0 96c-13.3 0-24 10.7-24 24s10.7 24 24 24l80 0c13.3 0 24-10.7 24-24s-10.7-24-24-24l-80 0z\"/></svg></div>\n\nTo make attr access more convenient, hyphens are replaced with\nunderscores, and icon names starting with a digit are prefixed with an\nunderscore.\n\nUse `width` to view the svg in a notebook with a different width (it\ndefaults to 300px).\n\n``` python\nsvgs._9.solid.width(25)\n```\n\n<div style=\"max-width: 25px; width: 100%;\"><svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 320 512\"><path d=\"M64 192a96 96 0 1 0 192 0A96 96 0 1 0 64 192zm87.5 159.8C67.1 347.4 0 277.5 0 192C0 103.6 71.6 32 160 32s160 71.6 160 160c0 2.6-.1 5.3-.2 7.9c-1.7 35.7-15.2 70-38.4 97.4l-145 171.4c-11.4 13.5-31.6 15.2-45.1 3.8s-15.2-31.6-3.8-45.1l63.9-75.6z\"/></svg></div>\n\nWhen stringified, the SVG text is returned:\n\n``` python\nprint(svgs._9.solid)\n```\n\n <svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 320 512\"><path d=\"M64 192a96 96 0 1 0 192 0A96 96 0 1 0 64 192zm87.5 159.8C67.1 347.4 0 277.5 0 192C0 103.6 71.6 32 160 32s160 71.6 160 160c0 2.6-.1 5.3-.2 7.9c-1.7 35.7-15.2 70-38.4 97.4l-145 171.4c-11.4 13.5-31.6 15.2-45.1 3.8s-15.2-31.6-3.8-45.1l63.9-75.6z\"/></svg>\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "fontawesome 6 free icons as SVGs",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/AnswerDotAI/fa6-icons"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "43f210440ca90fed34192e707dc123dd3f9318f4bb0b61942bcd01671162e50f",
"md5": "da8ed2ed7df45f2108b4f53b0d1ffce3",
"sha256": "2d233c99219db8e75597d5c07cdcbf32c6920ba15b0c922dd950f59a78eafd59"
},
"downloads": -1,
"filename": "fa6_icons-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "da8ed2ed7df45f2108b4f53b0d1ffce3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 630291,
"upload_time": "2024-08-25T05:39:26",
"upload_time_iso_8601": "2024-08-25T05:39:26.656953Z",
"url": "https://files.pythonhosted.org/packages/43/f2/10440ca90fed34192e707dc123dd3f9318f4bb0b61942bcd01671162e50f/fa6_icons-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2423ef93c1c8b26ccbcfcf203d2026b703238eaadf92d428462ca69c1ede4cf0",
"md5": "b5024d7e988ac2d48b0d1d3ca582b617",
"sha256": "9a419e4c7b70fe110207a851d9bd2dc4190c0baf7c8eb669c3573b7c8598bce7"
},
"downloads": -1,
"filename": "fa6-icons-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "b5024d7e988ac2d48b0d1d3ca582b617",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 623435,
"upload_time": "2024-08-25T05:39:28",
"upload_time_iso_8601": "2024-08-25T05:39:28.337500Z",
"url": "https://files.pythonhosted.org/packages/24/23/ef93c1c8b26ccbcfcf203d2026b703238eaadf92d428462ca69c1ede4cf0/fa6-icons-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 05:39:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AnswerDotAI",
"github_project": "fa6-icons",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fa6-icons"
}
JSON
