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

image

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
Or install the testing branch:

which can be unstable or have breaking changes:

  • pip install git+https://github.com/Soheab/alexflipnote.py@testing -U
  • python -m pip install git+https://github.com/Soheab/alexflipnote.py@testing -U

Changelog

See the changelog for each version here

Examples

Get a random cat pic:

import alexflipnote

afa = alexflipnote.Client()

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

await afa.close() # closing the session to prevent the "Unclosed client session" warning

Make a custom supreme logo:

import alexflipnote

afa = alexflipnote.Client()

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

await afa.close() # closing the session to prevent the "Unclosed client session" warning

Minecraft achievement using discord.py:

import discord
import alexflipnote
from discord.ext import commands
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: 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"))
    await alex_api.close() # closing the session to prevent the "Unclosed client session" warning

# 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
# output: https://api.alexflipnote.dev/achievement?text=nice%20job&icon=3
bot.run("TOKEN")

Made by

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

You can join my discord server here or AlexFlipnote's server here (recommended)

Please report any bugs in the servers above or dm.

Suggestions are also welcome.

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.3.0.tar.gz (6.6 kB view hashes)

Uploaded Source

Built Distribution

alexflipnote.py-1.3.0-py3-none-any.whl (7.2 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