auric 0.0.2

A modern, powerful, and type-safe Discord API wrapper for Python

🌟 Auric

A modern, powerful, and type-safe Discord API wrapper for Python

Installation • Quick Start • Documentation • Examples • Contributing

---

📖 Overview

Auric is a powerful, asynchronous, and fully type-hinted Python library for interacting with the Discord API. Built from the ground up with modern Python features, it provides an intuitive and elegant interface for creating everything from simple bots to complex, production-ready applications.

✨ Key Features

🚀 Modern & Performant

• Async/Await: Built with modern Python async/await patterns for high-performance I/O operations
• Type-Safe: 100% type-hinted codebase with full IDE support and autocompletion
• Optimized: Uses aiohttp for networking and optional orjson for ultra-fast JSON processing

🎯 Comprehensive Discord API Support

• Slash Commands - Application commands with full option types support
• Message Components - Buttons, select menus, and modals
• Voice & Audio - Voice channel connection and audio playback
• Threads & Forums - Complete thread and forum channel support
• Auto-Moderation - Auto-mod rules and filters
• Scheduled Events - Create and manage guild events
• Stage Channels - Stage instance management
• Monetization - SKUs and subscription support

🛠️ Developer Experience

• Fluent Builders - Chainable builders for embeds, commands, and components
• Smart Collectors - Built-in collectors for messages, reactions, and interactions
• Plugin System - Organize your bot into reusable, modular plugins
• Advanced Caching - Intelligent caching with automatic memory management
• Auto-Sharding - Seamless sharding support for scaling to thousands of guilds

📦 Installation

Stable Release (Recommended)

pip install -U auric

With Voice Support

pip install -U "auric[voice]"

With Performance Optimizations

pip install -U "auric[speed]"

Development Version

pip install -U git+https://github.com/yourusername/auric.git

Requirements: Python 3.11 or higher

🚀 Quick Start

Basic Bot Example

import auric

# Create a client with default intents
client = auric.Client(intents=auric.Intents.default())

@client.event
async def on_ready():
    print(f"✅ Logged in as {client.user.username}")
    print(f"📊 Connected to {len(client.guilds)} guilds")

@client.event
async def on_message(message):
    # Don't respond to ourselves
    if message.author.bot:
        return
    
    if message.content.startswith("!ping"):
        await message.reply("🏓 Pong!")

# Run the bot
client.run("YOUR_BOT_TOKEN")

Slash Command Example

import auric
from auric.builders import EmbedBuilder

client = auric.Client(intents=auric.Intents.default())

@client.slash_command(name="hello", description="Greet someone")
async def hello_command(interaction: auric.Interaction, name: str):
    """Say hello to a user"""
    embed = (
        EmbedBuilder()
        .set_title(f"👋 Hello, {name}!")
        .set_description("Welcome to the server!")
        .set_color(0x5865F2)
        .set_footer(text=f"Requested by {interaction.user.username}")
        .build()
    )
    await interaction.reply(embed=embed)

client.run("YOUR_BOT_TOKEN")

Components & Modals Example

import auric
from auric.builders import ButtonBuilder, ActionRowBuilder

client = auric.Client(intents=auric.Intents.default())

@client.slash_command(name="button", description="Show a button")
async def button_command(interaction: auric.Interaction):
    button = ButtonBuilder().set_label("Click me!").set_custom_id("my_button").build()
    row = ActionRowBuilder().add_component(button).build()
    
    await interaction.reply("Click the button below:", components=[row])

@client.event
async def on_interaction(interaction):
    if interaction.type == auric.InteractionType.COMPONENT:
        if interaction.data.custom_id == "my_button":
            await interaction.reply("🎉 Button clicked!")

client.run("YOUR_BOT_TOKEN")

📚 Examples

Check out more examples in the repository:

• Simple Bot - Basic message handling
• Slash Commands - Application commands
• Components - Buttons and select menus
• Modals - Interactive forms
• Collectors - Message and reaction collectors
• Voice Bot - Voice channel features
• Plugin System - Modular bot structure

📖 Documentation

Coming soon! In the meantime, the codebase is fully type-hinted with comprehensive docstrings.

# Every function has detailed documentation
help(auric.Client)
help(auric.Embed)
help(auric.SlashCommandBuilder)

🤝 Contributing

We welcome contributions! Here's how you can help:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Please read our Contributing Guide for detailed guidelines.

Development Setup

# Clone the repository
git clone https://github.com/yourusername/auric.git
cd auric

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Run linter
flake8 auric
black auric --check

🛠️ Roadmap

• Complete API v10 coverage
• Comprehensive documentation website
• More examples and tutorials
• Performance benchmarks
• Database integration helpers
• Advanced plugin templates

💬 Support & Community

• GitHub Issues: Report bugs or request features
• GitHub Discussions: Ask questions and discuss ideas
• Discord: Coming soon!

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgements

• Built with ❤️ for the Discord bot development community
• Inspired by discord.py, discord.js, and other great Discord libraries
• Special thanks to all contributors

---

If you find Auric useful, please consider giving it a ⭐ on GitHub!

Made with ❤️ by the Auric Team