Skip to main content

A flexible command & component handler

Project description

banner

Aurum

Static Badge PyPI - Python Version PyPI - Downloads PyPI - Status GitHub commit activity GitHub Issues or Pull Requests GitHub License

Documentation · Releases · PyPI · License

A flexible command & component handler.

The main purpose of this library is to help you create a bot and implement its functionality. It makes the process simpler and easier. Our goal is to provide you, as developers, with complete freedom of action and to highlight the benefits of Hikari.

Installation

[!NOTE] Aurum requires Python 3.10 or higher.

Run command:

pip install aurum-hikari
# Or
python -m pip install aurum-hikari # for unix-type systems
py -m pip install aurum-hikari # for windows
# You can use the -U flag with the `install` command (e.g., `pip install -U ...`) to update a package.

Usage

from hikari import GatewayBot

from aurum import Client, SlashCommand, callback

bot = GatewayBot("...")
client = Client(bot)


@client.include
class HelloCommand(SlashCommand):
    def __init__(self) -> None:
        super().__init__(name="hello", description="Say hi to bot")

    async def callback(self, context: InteractionContext) -> None:
        await context.create_response(f"Hi, {context.user.mention}!")


if __name__ == "__main__":
    client.run()

More in examples folder.

Projects

So far, no one has been using our library.

Contributing

Not available yet.

Issues and bugs

If you find any errors in the library, please let us know about them on the issues Github page. Thanks!

Inspiration

  • hikari-crescent - A command handler for Hikari that keeps your project neat and tidy.

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

aurum_hikari-0.1.4.tar.gz (17.2 kB view hashes)

Uploaded Source

Built Distribution

aurum_hikari-0.1.4-py3-none-any.whl (29.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