Metadata-Version: 2.1
Name: alexflipnote.py
Version: 1.2.2
Summary: An easy to use Python Wrapper for the AlexFlipnote API
Home-page: https://github.com/Soheab/Alexflipnote.py
Author: Soheab
Author-email: 
License: MIT
Download-URL: https://github.com/Soheab/alexflipnote.py/archive/1.2.2.tar.gz
Platform: UNKNOWN
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: aiohttp
Requires-Dist: url-regex

[![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


# Requirements
- Python 3.6 or above
- aiohttp (python3 -m pip install -U aiohttp)
- url_regex (python3 -m pip install -U url_regex)

# installation

### Using pip (recommended):
Install the package by doing one of the following commands:

- `pip install alexflipnote.py`
- `python -m pip -U install alexflipnote.py`

# Documentation
---
See the full and detailed [docs here](docs.md)
# Examples

#### Get a random cat pic:

```py
import alexflipnote

afa = alexflipnote.Client()

print(await afa.cats())
>>> https://api.alexflipnote.dev/cats/grRlHyi-AL8_cats.jpg
``` 

#### Make a custom supreme logo:

```py
import alexflipnote

afa = alexflipnote.Client()

print(await afa.supreme("#some text, yes", dark=True)) # making it dark, there is also light option.
>>> https://api.alexflipnote.dev/supreme?text=%23some%20text,%20yes&dark=true
``` 

#### Minecraft achievement using [discord.py](https://github.com/Rapptz/discord.py)

```py
import alexflipnote
from typing import Union

# just a example, alexflipnote client doesn't have to be under bot.

bot = commands.Bot(command_prefix="!")
alex_api = alexflipnote.Client()

@bot.command()
async def achievement(ctx, text, icon: Union[int, str] = None): 
    achivement = await alex_api.achievement(text=text, icon=icon)
    achivement_bytes = await achivement.read() # BytesIO
    await ctx.send(f"Rendered by {ctx.author}",
                    file=discord.File(achivement_bytes, filename="achievement.png")
                    )

# we did a Union[int, str] since the wrapper accepts a number or string for the icon, 
see the icon section in docs to see what it accepts.

# invoke: !achievement "nice job!" diamond_sword

bot.run("TOKEN")
```
# Made by

This wrapper is made Soheab_#6240, contact me for anything related to this wrapper.

You can join my discord [server here](https://discord.gg/yCzcfju) or 
AlexFlipnote's [server here](https://discord.gg/alexflipnote) (recommended)

Please report any bugs in the servers above or dm.

Suggestions are also welcome.



