Metadata-Version: 2.1
Name: simpleicons
Version: 4.4.0.4
Summary: Use a wide-range of icons derived from the simple-icons/simple-icons repo in python.
Home-page: https://github.com/xCloudzx/simpleicons
Author: Sachin Raja
Author-email: sachinraja2349@gmail.com
License: MIT
Description: # simpleicons
        Use a wide-range of icons derived from the [simple-icons](https://github.com/simple-icons/simple-icons) repo in python. Go to [their website](https://simpleicons.org/) for a full list of icons. The slug version (all lowercase and no spaces with some exceptions) must be used for the `icon_name`. The icons folder that accompanies the package has all the files. The package searches for icons by filename.
        
        ## Installation
        Install with `pip install simpleicons`. Keep in mind that this is a fairly large package due to all the icons (a couple of megabytes).
        ## XML
        The XML for each icon can be easily manipulated with either of two functions:
        
        `get_xml(icon_name: str, **attrs) -> ElementTree`
        
        ```py
        from simpleicons.icon_xml import get_xml
        
        # blue logo (simply adds <svg fill="blue"></svg>)
        get_xml("github", fill="blue")
        ```
        
        `get_xml_bytes(icon_name: str, **attrs) -> bytes`
        
        ```py
        from simpleicons.icon_xml import get_xml_bytes
        
        get_xml_bytes("github", fill="blue")
        ```
        
        To simply get the unparsed XML string for each icon, use `get_str(icon_name: str) -> str`:
        
        ```py
        from simpleicons.icon_xml import get_str
        
        get_str("github")
        ```
        
        This string representation will allow for quick implementation in web pages, however it cannot be manipulated. Use `get_xml_bytes` for easy web page implementation alongside manipulation.
        
        ## Image
        Icons can be converted to PIL Images with `icon_to_image(icon_xml: bytes, bg: int=0xffffff, scale: Tuple[int, int]=(1, 1)) -> Image`:
        
        ```py
        from simpleicons.icon_xml import get_xml_bytes
        from simpleicons.image import icon_to_image
        
        xml_bytes = get_xml_bytes("github", fill="blue")
        
        # black background and x5 scale
        img = icon_to_image(xml_bytes, bg=0x000000, scale=(5, 5))
        
        # manipulate PIL Image
        img.putalpha(32)
        img.save("github.png")
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
