Metadata-Version: 2.1
Name: Tawpy
Version: 0.1.2
Summary: For requesting gifs from the tenor website
Home-page: https://github.com/devKeef/Tawpy
Author: devKeef
Author-email: keef.devv@gmail.com
License: UNKNOWN
Description: # [Tawpy](https://tenor.com/gifapi/documentation)
        
        An `asynchronous` api wrapper writen in python originally made to be used for [discord.py](https://discordpy.readthedocs.io/en/stable/)
        
        ## Features 
        -   Almost full coverage of the `Tenor` api
        -   `Asynchronous` support has been added
        -   The ability to request gifs from the `Tenor` website
        
        ## Installing Tawpy 
        ### Requires Python Version 3.7 +
        ```sh
        # Linux/macOS
        python3 -m pip install -U tawpy
        
        # Windows
        py -3 -m pip install -U tawpy
        ```
        To install the development version and contribute do: 
        ```sh
        $ git clone https://github.com/devKeef/tawpy
        $ cd tawpy
        ```
        
        
        ## Quick Example
        ```py
        from tawpy import Tenor
        from tawpy import Enum
        
        
        
        tenor = Tenor("API_KEY")
        print(tenor.trending_gifs())
        """ 
        OUTPUT 
        
        ['https://media.tenor.com/images/0b26816e611b5511ece09f6db6c6f593/tenor.gif', 
        'https://media.tenor.com/images/0d194d2aa3bbc0f0c2d0fe42b05ae274/tenor.gif', 
        'https://media.tenor.com/images/0997e68794ba980c948561c66cf4c541/tenor.gif', 
        'https://media.tenor.com/images/abcc26ae5960d42fc9d3897e2c6ee303/tenor.gif', 
        'https://media.tenor.com/images/a2c1f41d08dbd2e769ad88de33fe00e2/tenor.gif']
        """
        ```
        
        ## HOW TO GET API KEY 
        VISIT https://tenor.com/developer/dashboard, create a new application and grab it's api key
        ## Documentation 
        This section of the markdown file contains the duties of specific functions and their parameters and how they affect the set `tuple` of gifs you reviece from `Tenor`
        ## Paremters
        ```
        Keep in mind that these are all keyword-arguments 
        there are no positional arguments all functions 
        are keyword-argument based.
        
        query: str
        The tag to be used to find an array or specific gif from 
        the tenor website.
        
        limt: int = 5 
        The number of gifs that you would like to request from the 
        tenor website with each call.
        
        contentfilter: Enum = Enum.ContentFilter.LOW 
        The the content safety of gifs requested from
        the tenor website with each call.
        
        mediafilter: Enum = Enum.MediaFilter.GIF 
        The format in which the gifs are returned in.
        
        pos: int = 5
        The position you want to start collection gif's from.
        
        locale: Enum = Enum.LocaleMedida.EN_US 
        The default language to interpret search string.
        ```
        ## Methods
        ```
        All methods in this section returns a tuple of gif urls 
        from tenor. 
        
        search_for_gif(
            query: str ,
            limit: int = 5 , 
            contentfilter: Enum = Enum.ContentFilter.OFF , 
            mediafilter: Enum = Enum.MediaFilter.GIF, 
            pos: int = 0 , 
            locale: Enum = Enum.LocaleMedia.EN_US
        )
        
        
        This function request gif's from the tenor 
        website starting listed most popular gif's to least.
        
        trending_gifs(
            limit: int = 5 , 
            contentfilter: Enum = Enum.ContentFilter.OFF , 
            mediafilter: Enum = Enum.MediaFilter.GIF, 
            locale: Enum = Enum.LocaleMedia.EN_US
        )
        
        This function request trending gif's 
        from the tenor website listed most popular gif's to least.
        
        
        c_random_gifs(
            query: str ,
            limit: int = 5 , 
            pos: int = 5 ,
            contentfilter: Enum = Enum.ContentFilter.OFF , 
            mediafilter: Enum = Enum.MediaFilter.GIF, 
            locale: Enum = Enum.LocaleMedia.EN_US
        )
        
        This function request random gif's from the tenor website with each call
        When i say random i mean random the listing order is not most popular to least 
        it is random completey random. 
        
        
        random_gifs(
            query: str ,
            limit: int = 5 , 
            pos: int = 0 ,
            contentfilter: Enum = Enum.ContentFilter.OFF , 
            mediafilter: Enum = Enum.MediaFilter.GIF, 
            locale: Enum = Enum.LocaleMedia.EN_US
        )
        
        This function request random gif's from the tenor website
        would use tenor_gif_search if i were you.
        ```
        ## Enums 
        ```
        Content Filters
        
        OFF: MAY INCLUDED NSFW GIFS
        LOW: A LOWER RISK OF NSFW GIFS 
        MEDIUM: AN EVEN LOWER RISK OF NSFW GIFS 
        HIGH: THE LOWEST RISK OF NSFW GIFS
        
        
        Media Filters
        
        Gifs
        ----
        GIF: HIGH QUALITY GIF FORMAT , LARGEST FORMAT OF GIF
        MEDIUMGIF: SMALL REDUCTION OF GIF FORMAT
        TINYGIF: REDUCED SIZE OF THE GIF FORMAT
        NANOGIF: SMALLEST SIZE OF GIF FORMAT
        
        Mp4
        ---
        MP4: HIGH QUALITY MP4 FORMAT , LARGEST FORMAT OF MP4
        LOOPEDMP4: SAME AS MP4
        TINYMP4: REDUCED SIZE OF THE MP4 FORMAT
        NANOMP4: SMALLEST SIZE OF MP4 FORM
        
        WEBM
        ----
        WEBM: LOWER QUALITY VIDEO FORMAT
        TINYWEBM: REDUCED SIZE OF WEBM FORMAT 
        NANOWEBM: SMALLEST SIZE OF WEBM FORMAT
        
        Language Codes 
        
        ZH_CN: CHINESE
        ZH_TW: TAIWAN
        EN_US: ENGLISH 
        FR_FR: FRENCH
        DE_DE: GERMAN
        IT_IT: ITALIAN 
        JA_JP: JAPANESE
        KO_KR: KOREAN
        PT_BR: PORTUGUESE
        ES_ES: SPANISH
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=2.7
Description-Content-Type: text/markdown
