Metadata-Version: 2.1
Name: pythonpixels
Version: 1.2.11
Summary: An API wrapper for the python discord pixels project
Home-page: https://github.com/sebkuip/pythonpixels
Author: sebkuip
Author-email: sebkuip@tekx.it
License: MIT
Description: # Pythonpixels
        
        *An API wrapper for the python discord pixels project*
        
        ## Requirements
        
        pillow, rich and request are required for this library. These are automatically installed with this library.
        
        ## Usage
        
        ### Getting started
        
        First make an instance of the Client class and pass your token to the contructor.
        Everything in this library is done from the Client class.
        
        ```py
        import pythonpixels
        
        client = pythonpixels.Client("TOKEN") # Your token must be inserted where it says TOKEN
        ```
        
        ### Methods
        
        ```py
        client.get_pixel(x, y)
        ```
        
        Returns the hexadecimal color code of the given pixel
            
        Params:
        x: int - The x position of the pixel
        y: int - The y position of the pixel
        
        Returns:
        int - The color of the requested pixel
        
        ```py
        client.get_canvas(scale)
        ```
        
        Fetch the entire canvas and returns it as a pillow Image instance. Optionally resize it by a scale factor
        
        Params:
        scale: int - A factor to resize the image by
        
        Returns:
        pillow.Image - The current canvas
        
        ```py
        client.get_size()
        ```
        
        Returns the size of the canvas
        
        Params:
        None
        
        Returns:
        tuple - The width and height of the canvas
        
        ```py
        client.set_pixel(x, y, color)
        ```
        
        Sets a pixel on the canvas
        
        Params:
        x: int - The x position of the pixel
        y: int - The y position of the pixel
        color: int - the RGB colorcode of the pixel
        
        Returns:
        None
        
        ```py
        client.set_picture(x, y, img)
        ```
        Starts a job to add a picture with offset x an y. Img can either be a file directory, an direct URL (Only HTTP supported) or a pillow.Image
        
        Params:
        x: int - The x offset
        y: int- The y offset
        img: typing.Union[str, pillow.Image.Image] - The image to upload. Can either be a path, a HTTP direct image link or a pillow image instance
        
        Returns:
        None
        
        ```py
        client.get_limits()
        ```
        
        Return the last known rate limits of the API. These are refreshed every request.
        
        Params:
        None
        
        Returns:
        dict - A dictionary with the rate limits formatted as follow
        "set_pixel": tuple(remaining, timeout)
        "get_pixel": tuple(remaining, timeout)
        "get_canvas": tuple(remaining, timeout)
Keywords: API
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Description-Content-Type: text/markdown
