Metadata-Version: 2.1
Name: pilmoji
Version: 2.0.1
Summary: Pilmoji is an emoji renderer for Pillow, Python's imaging library.
Home-page: https://github.com/jay3332/pilmoji
Author: jay3332
License: MIT
Project-URL: Issue tracker, https://github.com/jay3332/pilmoji
Project-URL: Discord, https://discord.gg/FqtZ6akWpd
Description: # Pilmoji
        Pilmoji is an emoji renderer for [Pillow](https://github.com/python-pillow/Pillow/), 
        Python's imaging library.
        
        Pilmoji comes equipped with support for both unicode emojis and Discord emojis.
        
        ## Features
        - Discord emoji support
        - Multi-line rendering support
        - Emoji position and/or size adjusting
        - Many built-in emoji sources
        - Optional caching
        
        ## Installation and Requirements
        You must have Python 3.8 or higher in order to install Pilmoji.
        
        Installation can be done with `pip`:
        ```shell 
        $ pip install -U pilmoji
        ```
        
        Optionally, you can add the `[requests]` option to install requests
        alongside Pilmoji:
        ```shell 
        $ pip install -U pilmoji[requests]
        ```
        
        The option is not required, instead if `requests` is not installed, 
        Pilmoji will fallback to use the builtin `urllib`.
        
        You may also install from Github.
        
        ## Usage
        ```py 
        from pilmoji import Pilmoji
        from PIL import Image, ImageFont
        
        
        my_string = '''
        Hello, world! 👋 Here are some emojis: 🎨 🌊 😎
        I also support Discord emoji: <:rooThink:596576798351949847>
        '''
        
        with Image.new('RGB', (550, 80), (255, 255, 255)) as image:
            font = ImageFont.truetype('arial.ttf', 24)
        
            with Pilmoji(image) as pilmoji:
                pilmoji.text((10, 10), my_string.strip(), (0, 0, 0), font)
        
            image.show()
        ```
        
        #### Result
        ![Example result](https://jay.has-no-bra.in/f/j4iEcc.png)
        
        ## Switching emoji sources
        As seen from the example, Pilmoji defaults to the `Twemoji` emoji source. 
        
        If you prefer emojis from a different source, for example Microsoft, simply
        set the `source` kwarg in the constructor to a source found in the 
        `pilmoji.source` module:
        
        ```py 
        from pilmoji.source import MicrosoftEmojiSource
        
        with Pilmoji(image, source=MicrosoftEmojiSource) as pilmoji:
            ...
        ```
        
        ![results](https://jay.has-no-bra.in/f/suPfj0.png)
        
        It is also possible to create your own emoji sources via subclass.
        
        ## Fine adjustments
        If an emoji looks too small or too big, or out of place, you can make fine adjustments 
        with the `emoji_scale_factor` and `emoji_position_offset` kwargs:
        
        ```py 
        pilmoji.text((10, 10), my_string.strip(), (0, 0, 0), font,
                     emoji_scale_factor=1.15, emoji_position_offset=(0, -2))
        ```
        
        ## Contributing
        Contributions are welcome. Make sure to follow [PEP-8](https://www.python.org/dev/peps/pep-0008/)
        styling guidelines.
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.8.0
Description-Content-Type: text/markdown
Provides-Extra: requests
