Skip to main content

An easy to use Python Wrapper for the AlexFlipnote API

Project description

PyPi Version Downloads MIT License

AlexFlipnote.py

An easy to use Python Wrapper for the AlexFlipnote API

drawing

Requirements

  • Python 3.6 or above
  • aiohttp (python3 -m pip install -U aiohttp)

Documentation

See the full and detailed docs here

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

Changelog

See the changelog for each version here

Examples

Get a random cat pic:

import asyncio
import alexflipnote

alex_api = alexflipnote.Client()


async def get_cat_pic():
    cat = await alex_api.cats()
    print(cat)
    # prints: https://api.alexflipnote.dev/cats/grRlHyi-AL8_cats.jpg
    await alex_api.close()  # preventing the "Unclosed client session" warning.


asyncio.get_event_loop().run_until_complete(get_cat_pic())

Make a custom supreme logo:

import asyncio
import alexflipnote

alex_api = alexflipnote.Client()


async def custom_supreme_logo(text, dark=False, light=False):
    supreme = await alex_api.supreme(text, dark, light)
    print(supreme)
    # prints: https://api.alexflipnote.dev/supreme?text=%23some%20text,%20yes&dark=true
    await alex_api.close()  # preventing the "Unclosed client session" warning.


asyncio.get_event_loop().run_until_complete(custom_supreme_logo('#some text, yes', dark=True))

Minecraft achievement using discord.py:

import discord
import alexflipnote
from discord.ext import commands
from typing import Union


bot = commands.Bot(command_prefix="!")
alex_api = alexflipnote.Client() # just a example, the client doesn't have to be under bot.

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

# have this where you close the bot or somewhere to close the session and prevent the "Unclosed client session" warning.
await alex_api.close()

# 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
# see output here: https://i.imgur.com/l9OcQNw.png

bot.run("TOKEN")

Made by

This wrapper is made by Soheab#6240, DM me on Discord or join my Server for anything related to this wrapper.

You can join AlexFlipnote's server here to suggests something for the API.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alexflipnote.py-1.5.3.tar.gz (6.9 kB view hashes)

Uploaded Source

Built Distribution

alexflipnote.py-1.5.3-py3-none-any.whl (7.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page