Metadata-Version: 2.1
Name: gatepoint
Version: 0.2
Summary: A Python library API for the Discord.
Home-page: https://github.com/Senarc-Studios/GatePoint
Author: BenitzCoding
License: MIT
Project-URL: Documentation, https://gatepoint.readthedocs.io/en/latest/
Project-URL: Issue tracker, https://github.com/Senarc-Studios/GatePoint/issues
Platform: UNKNOWN
Classifier: Framework :: FastAPI
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.8.0
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: fastapi
Requires-Dist: uvicorn
Provides-Extra: docs
Requires-Dist: sphinx (==4.4.0) ; extra == 'docs'
Requires-Dist: sphinxcontrib-trio (==1.1.2) ; extra == 'docs'
Requires-Dist: sphinxcontrib-websupport ; extra == 'docs'
Requires-Dist: typing-extensions (<5,>=4.3) ; extra == 'docs'
Provides-Extra: speed
Requires-Dist: orjson (>=3.5.4) ; extra == 'speed'
Requires-Dist: aiodns (>=1.1) ; extra == 'speed'
Requires-Dist: Brotli ; extra == 'speed'
Requires-Dist: cchardet (==2.1.7) ; (python_version < "3.10") and extra == 'speed'
Provides-Extra: test
Requires-Dist: coverage[toml] ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-asyncio ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: pytest-mock ; extra == 'test'
Requires-Dist: typing-extensions (<5,>=4.3) ; extra == 'test'
Provides-Extra: voice
Requires-Dist: PyNaCl (<1.6,>=1.3.0) ; extra == 'voice'

GatePoint
==========

.. image:: https://discord.com/api/guilds/886543799843688498/embed.png
    :target: https://discord.gg/5YY3W83YWg
    :alt: Discord server invite
.. image:: https://img.shields.io/pypi/v/gatepoint.svg
    :target: https://pypi.python.org/pypi/gatepoint
    :alt: PyPI version info
.. image:: https://img.shields.io/pypi/pyversions/gatepoint.svg
    :target: https://pypi.python.org/pypi/gatepoint
    :alt: PyPI supported Python versions

An API Client for Discord Interactions written in Python.

Key Features
-------------

- Modern Python API using ``FastAPI`` for Discord.
- Optimised to work in serverless environments.
- API Client over Real-time connection.

Installing
----------

**Python 3.8 or higher is required**

To install the library without full voice support, you can just run the following command:

.. code:: sh

    # Linux/macOS
    python3 -m pip install -U gatepoint

    # Windows
    py -3 -m pip install -U gatepoint

To install the development version, do the following:

.. code:: sh

    $ git clone https://github.com/Senarc-Studios/gatepoint
    $ cd gatepoint
    $ python3 -m pip install -U .

Quick Example
--------------

.. code:: py

    import gatepoint
    from gatepoint import CommandInteraction

    Client = gatepoint.GatewayClient(
        api_version = 11,
        secret_key = "SECRET",
        public_key = "PUBLIC",
        token =  "TOKEN"
    )

    @Client.register(
        CommandInteraction(
            name = "ping",
            description = "Pong!"
        )
    )
    async def ping(interaction):
        await interaction.reply('pong!')

    Client.run()

You can find more examples in the examples directory.

Links
------

- `Documentation <https://gatepoint.readthedocs.io/en/latest/index.html>`_
- `Official Discord Server <https://discord.gg/5YY3W83YWg>`_
- `Discord API <https://discord.gg/discord-api>`_


