Metadata-Version: 2.1
Name: alexflipnote.py
Version: 2.4.0
Summary: An easy to use Python Wrapper for the AlexFlipnote API
Home-page: https://github.com/Soheab/alexflipnote.py/tree/2.x
Author: Soheab_
License: MIT
Download-URL: https://github.com/Soheab/alexflipnote.py/archive/v2.4.0.tar.gz
Project-URL: Discord, https://discord.gg/DpxkY3x
Project-URL: Documentation, https://github.com/Soheab/alexflipnote.py/blob/2.x/docs.md
Description: [![Downloads Total](https://pepy.tech/badge/alexflipnote-py)](https://pepy.tech/project/alexflipnote-py)
        [![Downloads Month](https://pepy.tech/badge/alexflipnote-py/month)](https://pepy.tech/project/alexflipnote-py)
        [![Downloads Week](https://pepy.tech/badge/alexflipnote-py/week)](https://pepy.tech/project/alexflipnote-py)
        [![PyPi Version](https://img.shields.io/pypi/v/alexflipnote.py.svg)](https://pypi.python.org/pypi/alexflipnote.py/)
        [![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs)
        
        # AlexFlipnote.py
        
        An easy-to-use Python Wrapper for the AlexFlipnote API
        
        <img src="https://alexflipnote.dev/branding/assets/avatar.png" alt="drawing" width="200"/>
        
        ## Tokens
        
        A change on 22/11/2020 to API has made an Authorization header with a personal token required for ALL endpoints. \
        ALL previous versions under 2.0.0 of this wrapper will no longer work and are considered to be deprecated!
        
        Wondering how to get an Auth token to use the API ? Join the API's support server here: https://discord.gg/DpxkY3x to
        request one.
        
        You can pass your token in the constructor like so, `alexflipnote.Client("YOUR-API-TOKEN")`.
        
        ### Update: 03/05/2021
        
        A change on 03/05/2021 has made the following endpoints (with related method) not require a token anymore:
        
        - `/colour/<hex>` | `.colour()`
        - `/colour/image/<hex>` | `.colour_image()`
        - `/colour/image/gradient/<hex>` | `.colour_image_gradient()`
        - `/birb` | `.birb()`
        - `/dogs` | `.dogs()`
        - `/sadcat` | `.sadcat()`
        - `/cats` | `.cats()`
        
        Because of this, since v2.4.0, it's no longer required to pass in a token the constructor unless you are going to use a
        method that requires it, it will raise a special exception "MissingToken" in that case.
        
        #### Embed
        
        For embedding links see [this][embed_example]
        
        ## Requirements
        
        - Python 3.6 or above
        - aiohttp (python3 -m pip install -U aiohttp)
        
        ## Installation
        
        Install the package by doing one of the following commands:
        
        **Using pip (recommended)**:
        
        - `pip install alexflipnote.py -U`
        - `python -m pip install alexflipnote.py -U`
        
        ## Documentation
        
        See the full and detailed [docs here][docs]
        
        ## Links
        
        [API][base_url] | [Changelogs][changelog] | [Examples][examples] | [Github][github] | [PyPi][pypi]
        
        ## Made by
        
        This wrapper is made by **Soheab_#6240** (150665783268212746), DM me on Discord or join my server [here][discord_mine]
        for anything related to this wrapper.
        
        Join AlexFlipnote's server [here][discord_alexflipnote] to suggest or report anything on the API.
        
        [docs]: https://github.com/Soheab/alexflipnote.py/blob/master/docs.md
        
        [changelog]: https://github.com/Soheab/alexflipnote.py/blob/master/changelog.md
        
        [examples]: https://github.com/Soheab/alexflipnote.py/blob/master/docs.md#examples
        
        [embed_example]: https://github.com/Soheab/alexflipnote.py/blob/master/docs.md#embed
        
        [base_url]: https://api.alexflipnote.dev
        
        [github]: https://github.com/Soheab/alexflipnote.py
        
        [pypi]: https://pypi.org/project/alexflipnote.py/
        
        [discord_alexflipnote]: https://discord.gg/DpxkY3x
        
        [discord_mine]: https://discord.gg/yCzcfju
        
Keywords: alexflipnote,discord,api,wrapper,memes,image,discord.py
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
