Metadata-Version: 2.4
Name: hata
Version: 1.3.95
Summary: A powerful asynchronous library for creating Discord bots in Python.
Home-page: https://github.com/HuyaneMatsu/hata
Author: HuyaneMatsu
Author-email: re.ism.tm@gmail.com
License: DBAD
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6,<3.12
Description-Content-Type: text/markdown
Requires-Dist: scarletio>=1.0.91
Requires-Dist: chardet>=2.0
Provides-Extra: all
Requires-Dist: PyNaCl>=1.3.0; extra == "all"
Requires-Dist: cchardet>=2.0; extra == "all"
Requires-Dist: inotify_simple>=1.3.5; extra == "all"
Requires-Dist: python-dateutil>=2.0; extra == "all"
Requires-Dist: snakeviz; extra == "all"
Requires-Dist: yappi; extra == "all"
Provides-Extra: autoreload
Requires-Dist: inotify_simple>=1.3.5; extra == "autoreload"
Provides-Extra: cpythonspeedups
Requires-Dist: cchardet>=2.0; extra == "cpythonspeedups"
Provides-Extra: profiling
Requires-Dist: snakeviz; extra == "profiling"
Requires-Dist: yappi; extra == "profiling"
Provides-Extra: relativedelta
Requires-Dist: python-dateutil>=2.0; extra == "relativedelta"
Provides-Extra: voice
Requires-Dist: PyNaCl>=1.3.0; extra == "voice"
Requires-Dist: libnacl; extra == "voice"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

<h1 align="center">
    <b>
        <a href="https://github.com/HuyaneMatsu/hata">
            Hata
        </a>
    </b>
</h1>

<p align="center">
    <b>
        A blazing fast Discord API wrapper that you can't deny
    </b>
</p>

<p align="center">
    <a href="https://discord.gg/3cH2r5d">Support Guild</a> |
    <a href="https://github.com/HuyaneMatsu/hata/tree/master/docs/topics">Topical documentation</a> |
    <a href="https://github.com/HuyaneMatsu/hata/tree/master/docs/examples">Examples</a> |
    <a href="https://www.astil.dev/project/hata/docs/hata">Technical documentation</a> |
    <a href="https://github.com/HuyaneMatsu/hata">Source</a>
</p>

<h1></h1>
<br>
<p align="center">
    New hata versions use
    <a href="https://github.com/discord/discord-api-docs/discussions/4510">
        Discord API V10
    </a>
    .
</p>

<h1></h1>

<h3 align="center">
    About
</h3>



Hata is an *asynchronous* [Discord API](https://discord.com/developers/docs/intro) wrapper built on top of scarletio.
It is designed to be easy to use, with also providing rich API offering everything what an advanced developer might
need.

Named after [Hata no Kokoro](https://en.touhouwiki.net/wiki/Hata_no_Kokoro) from Touhou Project.

<h1></h1>

<h3 align="center">
    Why hata?
</h3>

- Multiple simultaneous clients

    Hata can run multiple clients from the same instance without sacrificing performance.

- Performant
    
    Fast concurrent code based on async/await paradigm with cache control, PyPy support and much more!

- Newest API features
    
    Whatever Discord decides to release/update/break Hata will support it natively in no time!

- 100% Python

    Built in Python! Easy to code, easy to read, easy to maintain.

<h1></h1>

<h3 align="center">
    Usage
</h3>

Simple example implementing a `ping` command.

```py
from hata import Client, Guild, wait_for_interruption

GUILD = Guild.precreate(guild_id)

Seija = Client('TOKEN', extensions = ['slash'])

@Seija.events
async def ready(client):
    print(f'{client:f} logged in.')

@Seija.interactions(guild = GUILD)
async def ping():
    """ping-pong"""
    return 'pong'

Seija.start()

wait_for_interruption()
```

<h1></h1>

*Hata leaves the main thread free, `client.start()` blocks it only till the client logs in (or fails it), although you
can still use the `start_clients()` function, what as it says, starts up all the non-running clients parallelly.*

*Sometimes leaving the main thread might cause problems when trying to shut down the bot(s). At this case, you might
want to use `wait_for_interruption()`, which disconnects the clients gracefully and closes the event loop on keyboard
interrupt.*

<h1></h1>

<h3 align="center">
    Installation
</h3>

To install Hata simply do

```shell
$ python3 -m pip install hata
```
And you are good to go! Hata has native pypy support as well if you need some more speed!

<h1></h1>

<h3 align="center">
    Dependencies
</h3>

#### Requirements

- Linux
- Python >= 3.6, < 3.12
- [chardet](https://pypi.python.org/pypi/chardet) / [cchardet](https://pypi.org/project/cchardet/)

#### Optional

- [dateutil](https://pypi.org/project/python-dateutil/)
- [PyNaCl](https://pypi.org/project/PyNaCl/)

<h1></h1>

<h3 align="center">
    Get in touch
</h3>

If you have issues, suggestions, want to contribute, or just want to hang out, join our discord server.

<p align="center">
    <a href="https://discord.gg/3cH2r5d">
        <img
            alt="Invite"
            src="https://discordapp.com/api/v9/guilds/388267636661682178/widget.png?style=banner1"
        />
    </a>
</p>

<h1></h1>

<h3 align="center">
    Acknowledgements
</h3>

Shout-Out to our brave testers who are helping the most to improve Hata!

- [`Koish`](https://github.com/UnconsciousPebble) \[Feature requests\]
- [`BrainDead`](https://github.com/albertopoljak) \[Documentation improvements\]
