Skip to content

Latest commit

 

History

History
123 lines (86 loc) · 6.96 KB

start-docs.md

File metadata and controls

123 lines (86 loc) · 6.96 KB

AlexFlipnote.py Documentation

An easy-to-use Python Wrapper for the AlexFlipnote API.

For questions or support, join the AlexFlipnote Discord server.

🚀 Getting Started

Install the package:

pip install -U alexflipnote.py
# or
python -m pip install -U alexflipnote.py
# or
python -m pip install -U git+https://github.com/soheab/alexflipnote.py

Create a client instance:

import alexflipnote

alex_api = alexflipnote.Client()

Throughout this documentation, alex_api refers to your client instance.

📚 API Reference

Methods

Method Description Aliases
achievement Generate a Minecraft achievement image
birb Get a random bird image bird
calling Generate a "calling" meme image
captcha Generate a fake captcha image
cats Get a random cat image or gif cat
challenge Generate a Minecraft challenge image
close Close the API client session
coffee Get a random coffee image
colour Get colour information color
did_you_mean Generate a "Did You Mean" meme image didyoumean
dogs Get a random dog image
drake Generate a Drake meme image
facts Generate a random fact image
nft Generate a random NFT image
pornhub Generate a Pornhub-style logo ph
sadcat Get a random sad cat image
scroll Generate a scroll meme image
sillycat Generate a silly cat NFT
support_server Get the support server invite

Classes

Enums

💡 Examples

Get a Random Cat Image

import asyncio
import alexflipnote

alex_api = alexflipnote.Client()

async def get_cat():
    url = await alex_api.cat()
    print(url)
    await alex_api.close()  # Prevent "Unclosed client session" warning

asyncio.run(get_cat())

Generate a Pornhub Logo with discord.py

from discord.ext import commands
import alexflipnote

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

@bot.command(aliases=["ph"])
async def phublogo(ctx, *, texts: str):
    white, yellow = texts.split(" | ")
    url = await alex_api.phub(white, yellow)
    await ctx.send(f"Requested by {ctx.author}\n{url}")

# Usage: !ph Epic Gamer | Moment

bot.run("TOKEN")

📎 Additional Resources

AlexFlipnote.py makes it easy to integrate fun image generation and data endpoints into your Python projects and Discord bots!