Skip to main content

A Python wrapper for the Fluxer API – a Discord-like platform. Inspired by discord.py.

Project description

fluxerpy3

A Python wrapper for the Fluxer API, inspired by discord.py's design. Fluxer is a Discord-like platform with guilds, channels, and messages.

Features

  • Async/await support – Built with modern Python async/await syntax
  • Easy to use – Simple and intuitive API similar to discord.py
  • Type hints – Full type hint support for better IDE integration
  • Gateway support – Real-time WebSocket events (MESSAGE_CREATE, GUILD_MEMBER_ADD, …)
  • Rich modelsGuild, Channel, Member, Role, Message, Reaction
  • Error handling – Custom exceptions for different error scenarios

Installation

pip install fluxerpy3

Or install in development mode:

pip install -e .

Quick Start

import asyncio
import fluxerpy3

async def main():
    async with fluxerpy3.Client(token="your_bot_token") as client:
        # Get the bot user
        me = await client.get_me()
        print(f"Logged in as: {me.username}")

        # List all guilds (servers)
        guilds = await client.get_guilds()
        for guild in guilds:
            print(f"  {guild.name}{guild.member_count} members")

        # Send a message
        await client.send_message("channel_id_here", "Hello from fluxerpy3! 🚀")

asyncio.run(main())

Usage Examples

Guild & Channel Operations

# Get a specific guild
guild = await client.get_guild("guild_id")

# Get all channels in a guild
channels = await client.get_guild_channels(guild.id)
text_channels = [c for c in channels if c.is_text_channel]

# Get recent messages from a channel
messages = await client.get_channel_messages("channel_id", limit=50)
for msg in messages:
    print(f"{msg.author}: {msg.content}")

# Create a new channel
new_channel = await client.create_channel(guild.id, "bot-log", topic="Bot activity log")

Message Operations

# Send a message
msg = await client.send_message("channel_id", "Hello!")

# Edit a message
edited = await client.edit_message("channel_id", msg.id, "Hello (edited)!")

# Delete a message
await client.delete_message("channel_id", msg.id)

# Convenience methods on Message objects
await msg.reply("Replying in the same channel")
await msg.edit("Updated content")
await msg.delete()

Reaction Operations

# Add a reaction
await client.add_reaction("channel_id", msg.id, "👍")

# Remove own reaction
await client.remove_reaction("channel_id", msg.id, "👍")

# Remove another user's reaction
await client.remove_reaction("channel_id", msg.id, "👍", user_id="user_id")

# Via Message object
await msg.add_reaction("🔥")

Member & Moderation Operations

# List members
members = await client.get_guild_members(guild.id, limit=100)

# Get a specific member
member = await client.get_guild_member(guild.id, "user_id")
print(f"{member.display_name} – roles: {member.roles}")

# Kick / ban / unban
await client.kick_member(guild.id, "user_id", reason="Rule violation")
await client.ban_member(guild.id, "user_id", reason="Spam", delete_message_seconds=86400)
await client.unban_member(guild.id, "user_id")

# Convenience methods on Member
await member.kick(reason="Rule violation")
await member.ban(reason="Spam")

Gateway (Real-time Events)

import asyncio
import fluxerpy3
from fluxerpy3 import Intents

async def on_message_create(data):
    author = data.get("author", {})
    print(f"{author.get('username')}: {data.get('content')}")

async def main():
    async with fluxerpy3.Client(token="your_bot_token") as rest:
        gateway_url = await rest.get_gateway_url()

    gw = fluxerpy3.GatewayClient(
        token="your_bot_token",
        gateway_url=gateway_url,
        intents=Intents.DEFAULT,
    )
    gw.on("MESSAGE_CREATE", on_message_create)
    await gw.connect()

asyncio.run(main())

API Reference

Client

User methods:

  • get_me() – Get the authenticated bot user
  • get_user(user_id) – Get a user by ID
  • get_user_by_username(username) – Look up a user by username

Guild methods:

  • get_guilds() – List all guilds the bot is in
  • get_guild(guild_id) – Get a specific guild
  • get_guild_channels(guild_id) – List channels in a guild
  • get_guild_members(guild_id, limit) – List members
  • get_guild_member(guild_id, user_id) – Get a specific member
  • get_guild_roles(guild_id) – List roles
  • kick_member(guild_id, user_id, reason) – Kick a member
  • ban_member(guild_id, user_id, reason, delete_message_seconds) – Ban a user
  • unban_member(guild_id, user_id) – Unban a user

Channel methods:

  • get_channel(channel_id) – Get a channel
  • create_channel(guild_id, name, channel_type, topic, parent_id, nsfw) – Create a channel
  • delete_channel(channel_id) – Delete a channel

Message methods:

  • get_channel_messages(channel_id, limit) – Fetch messages
  • get_message(channel_id, message_id) – Fetch one message
  • send_message(channel_id, content) – Send a message
  • edit_message(channel_id, message_id, content) – Edit a message
  • delete_message(channel_id, message_id) – Delete a message

Reaction methods:

  • add_reaction(channel_id, message_id, emoji) – Add a reaction
  • remove_reaction(channel_id, message_id, emoji, user_id) – Remove a reaction

Gateway:

  • get_gateway_url() – Fetch WSS gateway URL
  • create_gateway_client(intents) – Create a GatewayClient

Models

Model Key properties
User username, discriminator, display_name, avatar_url, bot, status
Guild name, icon_url, owner_id, member_count, description
Channel name, type, guild_id, topic, is_text_channel, is_voice_channel, is_category
Member user, nick, display_name, guild_id, roles, joined_at
Role name, color, permissions, position, mentionable, hoist
Message content, channel_id, guild_id, author, member, created_at, reactions, attachments
Reaction emoji, count, me

Error Handling

from fluxerpy3 import AuthenticationError, NotFoundError, RateLimitError, APIError

try:
    async with fluxerpy3.Client(token="invalid") as client:
        await client.get_me()
except AuthenticationError:
    print("Invalid bot token")
except NotFoundError:
    print("Resource not found")
except RateLimitError as e:
    print(f"Rate limited. Retry after {e.retry_after}s")
except APIError as e:
    print(f"API error {e.status_code}: {e}")

License

MIT License – see LICENSE file for details

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

fluxerpy3-0.1.2.1.tar.gz (27.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fluxerpy3-0.1.2.1-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

Details for the file fluxerpy3-0.1.2.1.tar.gz.

File metadata

  • Download URL: fluxerpy3-0.1.2.1.tar.gz
  • Upload date:
  • Size: 27.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for fluxerpy3-0.1.2.1.tar.gz
Algorithm Hash digest
SHA256 829166d1697e2031da4ea1531b034e5e9d5aeda6c9427f38c6d12865cf9e41a3
MD5 66d3072599b3ce67b614a0f80567fc56
BLAKE2b-256 4ae445c3a0727c0fc9437c8efc224a88577364f536fdef31a0d4bdb8a066dd46

See more details on using hashes here.

File details

Details for the file fluxerpy3-0.1.2.1-py3-none-any.whl.

File metadata

  • Download URL: fluxerpy3-0.1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 20.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.5

File hashes

Hashes for fluxerpy3-0.1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cf2a06e85bc635b2049df25a3f126a390121aafeac6f017892d941e5fbb73310
MD5 8340a0ed68083f68ad8377c4b11b88bf
BLAKE2b-256 ed8585035b6585185bb79642a0a17881fd9f06c3fdc2c6d3d058d955e9c29558

See more details on using hashes here.

Supported by

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