discord.py-self


Namediscord.py-self JSON
Version 2.0.0 PyPI version JSON
download
home_pagehttps://github.com/dolfies/discord.py-self
SummaryA Python wrapper for the Discord user API
upload_time2023-04-07 22:39:46
maintainer
docs_urlNone
authorDolfies
requires_python>=3.8.0
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            discord.py-self
================

.. image:: https://img.shields.io/endpoint?url=https%3A%2F%2Frunkit.io%2Fdamiankrawczyk%2Ftelegram-badge%2Fbranches%2Fmaster%3Furl%3Dhttps%3A%2F%2Ft.me%2Fdpy_self
   :target: https://t.me/dpy_self
   :alt: Telegram chat
.. image:: https://img.shields.io/pypi/v/discord.py-self.svg
   :target: https://pypi.python.org/pypi/discord.py-self
   :alt: PyPI version info
.. image:: https://img.shields.io/pypi/pyversions/discord.py.svg
   :target: https://pypi.python.org/pypi/discord.py-self
   :alt: PyPI supported Python versions
.. image:: https://img.shields.io/pypi/dm/discord.py-self.svg
   :target: https://pypi.python.org/pypi/discord.py-self
   :alt: PyPI downloads per month

A modern, easy to use, feature-rich, and async ready API wrapper for Discord's user API written in Python.

| **Note:**
| Automating user accounts is against the Discord ToS. This library is a proof of concept and I cannot recommend using it. Do so at your own risk.

Fork Changes
------------

These changes have become too numerous to mention, so check out our `docs <https://discordpy-self.readthedocs.io/en/latest/index.html>`_.

**Credits:**

- `Rapptz <https://github.com/Rapptz>`_ for the original library this fork is based on. Without it, the project would not exist.
- `arandomnewaccount <https://www.reddit.com/user/obviouslymymain123/>`_ for help when the project was first started.

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

- Modern Pythonic API using ``async`` and ``await``.
- Proper rate limit handling.
- Optimised in both speed and memory.
- Mostly compatible with the upstream ``discord.py``.
- Prevents user account automation detection.
- Implements vast amounts of the user account-specific API. For a non-exhaustive list:

  * Sessions
  * Connections
  * Relationships
  * Protobuf user settings
  * Application/team management
  * Store/SKUs/entitlements
  * Billing (e.g. subscriptions, payments, boosts, promotions, etc.)
  * Interactions (slash commands, buttons, etc.)

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 discord.py-self

    # Windows
    py -3 -m pip install -U discord.py-self

Otherwise to get voice support you should run the following command:

.. code:: sh

    # Linux/macOS
    python3 -m pip install -U "discord.py-self[voice]"

    # Windows
    py -3 -m pip install -U discord.py-self[voice]


To install the development version, do the following:

.. code:: sh

    $ git clone https://github.com/dolfies/discord.py-self
    $ cd discord.py-self
    $ python3 -m pip install -U .[voice]


Optional Packages
~~~~~~~~~~~~~~~~~~

* `PyNaCl <https://pypi.org/project/PyNaCl/>`__ (for voice support)

Please note that on Linux installing voice you must install the following packages via your favourite package manager (e.g. ``apt``, ``dnf``, etc) before running the above commands:

* libffi-dev (or ``libffi-devel`` on some systems)
* python-dev (e.g. ``python3.6-dev`` for Python 3.6)

Using with Upstream
~~~~~~~~~~~~~~~~~~~~

If you would like to use the library alongside upstream ``discord.py``, you can install ``selfcord.py`` instead of ``discord.py-self``. Check out the `renamed branch <https://github.com/dolfies/discord.py-self/tree/renamed>`_ for more information.

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

.. code:: py

    import discord

    class MyClient(discord.Client):
        async def on_ready(self):
            print('Logged on as', self.user)

        async def on_message(self, message):
            # only respond to ourselves
            if message.author != self.user:
                return

            if message.content == 'ping':
                await message.channel.send('pong')

    client = MyClient()
    client.run('token')

Bot Example
~~~~~~~~~~~~~

.. code:: py

    import discord
    from discord.ext import commands

    bot = commands.Bot(command_prefix='>', self_bot=True)

    @bot.command()
    async def ping(ctx):
        await ctx.send('pong')

    bot.run('token')

You can find more examples in the examples directory.

Links
------

- `Documentation <https://discordpy-self.readthedocs.io/en/latest/index.html>`_
- `Project updates <https://t.me/dpy_self>`_
- `Discussion & support <https://t.me/dpy_self_discussions>`_

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/dolfies/discord.py-self",
    "name": "discord.py-self",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "Dolfies",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/f0/e1/cd9cb28e9cc061904f468ee690eb63ea0fceac56bb8481550527377b71b8/discord.py-self-2.0.0.tar.gz",
    "platform": null,
    "description": "discord.py-self\n================\n\n.. image:: https://img.shields.io/endpoint?url=https%3A%2F%2Frunkit.io%2Fdamiankrawczyk%2Ftelegram-badge%2Fbranches%2Fmaster%3Furl%3Dhttps%3A%2F%2Ft.me%2Fdpy_self\n   :target: https://t.me/dpy_self\n   :alt: Telegram chat\n.. image:: https://img.shields.io/pypi/v/discord.py-self.svg\n   :target: https://pypi.python.org/pypi/discord.py-self\n   :alt: PyPI version info\n.. image:: https://img.shields.io/pypi/pyversions/discord.py.svg\n   :target: https://pypi.python.org/pypi/discord.py-self\n   :alt: PyPI supported Python versions\n.. image:: https://img.shields.io/pypi/dm/discord.py-self.svg\n   :target: https://pypi.python.org/pypi/discord.py-self\n   :alt: PyPI downloads per month\n\nA modern, easy to use, feature-rich, and async ready API wrapper for Discord's user API written in Python.\n\n| **Note:**\n| Automating user accounts is against the Discord ToS. This library is a proof of concept and I cannot recommend using it. Do so at your own risk.\n\nFork Changes\n------------\n\nThese changes have become too numerous to mention, so check out our `docs <https://discordpy-self.readthedocs.io/en/latest/index.html>`_.\n\n**Credits:**\n\n- `Rapptz <https://github.com/Rapptz>`_ for the original library this fork is based on. Without it, the project would not exist.\n- `arandomnewaccount <https://www.reddit.com/user/obviouslymymain123/>`_ for help when the project was first started.\n\nKey Features\n-------------\n\n- Modern Pythonic API using ``async`` and ``await``.\n- Proper rate limit handling.\n- Optimised in both speed and memory.\n- Mostly compatible with the upstream ``discord.py``.\n- Prevents user account automation detection.\n- Implements vast amounts of the user account-specific API. For a non-exhaustive list:\n\n  * Sessions\n  * Connections\n  * Relationships\n  * Protobuf user settings\n  * Application/team management\n  * Store/SKUs/entitlements\n  * Billing (e.g. subscriptions, payments, boosts, promotions, etc.)\n  * Interactions (slash commands, buttons, etc.)\n\nInstalling\n----------\n\n**Python 3.8 or higher is required.**\n\nTo install the library without full voice support, you can just run the following command:\n\n.. code:: sh\n\n    # Linux/macOS\n    python3 -m pip install -U discord.py-self\n\n    # Windows\n    py -3 -m pip install -U discord.py-self\n\nOtherwise to get voice support you should run the following command:\n\n.. code:: sh\n\n    # Linux/macOS\n    python3 -m pip install -U \"discord.py-self[voice]\"\n\n    # Windows\n    py -3 -m pip install -U discord.py-self[voice]\n\n\nTo install the development version, do the following:\n\n.. code:: sh\n\n    $ git clone https://github.com/dolfies/discord.py-self\n    $ cd discord.py-self\n    $ python3 -m pip install -U .[voice]\n\n\nOptional Packages\n~~~~~~~~~~~~~~~~~~\n\n* `PyNaCl <https://pypi.org/project/PyNaCl/>`__ (for voice support)\n\nPlease note that on Linux installing voice you must install the following packages via your favourite package manager (e.g. ``apt``, ``dnf``, etc) before running the above commands:\n\n* libffi-dev (or ``libffi-devel`` on some systems)\n* python-dev (e.g. ``python3.6-dev`` for Python 3.6)\n\nUsing with Upstream\n~~~~~~~~~~~~~~~~~~~~\n\nIf you would like to use the library alongside upstream ``discord.py``, you can install ``selfcord.py`` instead of ``discord.py-self``. Check out the `renamed branch <https://github.com/dolfies/discord.py-self/tree/renamed>`_ for more information.\n\nQuick Example\n--------------\n\n.. code:: py\n\n    import discord\n\n    class MyClient(discord.Client):\n        async def on_ready(self):\n            print('Logged on as', self.user)\n\n        async def on_message(self, message):\n            # only respond to ourselves\n            if message.author != self.user:\n                return\n\n            if message.content == 'ping':\n                await message.channel.send('pong')\n\n    client = MyClient()\n    client.run('token')\n\nBot Example\n~~~~~~~~~~~~~\n\n.. code:: py\n\n    import discord\n    from discord.ext import commands\n\n    bot = commands.Bot(command_prefix='>', self_bot=True)\n\n    @bot.command()\n    async def ping(ctx):\n        await ctx.send('pong')\n\n    bot.run('token')\n\nYou can find more examples in the examples directory.\n\nLinks\n------\n\n- `Documentation <https://discordpy-self.readthedocs.io/en/latest/index.html>`_\n- `Project updates <https://t.me/dpy_self>`_\n- `Discussion & support <https://t.me/dpy_self_discussions>`_\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A Python wrapper for the Discord user API",
    "version": "2.0.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6c867f54e265f2bacb29355d024c8ca9135811591ea5c60dbd57bed001a199f3",
                "md5": "a0308c07815ea5b8b06903346983ec2b",
                "sha256": "14b8cfbb301fa4acb428c2fce61ca796099bba64e59f88395bc34dc3f504e1b0"
            },
            "downloads": -1,
            "filename": "discord.py_self-2.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a0308c07815ea5b8b06903346983ec2b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.0",
            "size": 1148567,
            "upload_time": "2023-04-07T22:39:43",
            "upload_time_iso_8601": "2023-04-07T22:39:43.158735Z",
            "url": "https://files.pythonhosted.org/packages/6c/86/7f54e265f2bacb29355d024c8ca9135811591ea5c60dbd57bed001a199f3/discord.py_self-2.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f0e1cd9cb28e9cc061904f468ee690eb63ea0fceac56bb8481550527377b71b8",
                "md5": "617cd1496fd99458f4504d821fc98546",
                "sha256": "8f643be6060875c2d3dc4d3979c06ce14ce0d15d826666b8eec3fe1ada69be17"
            },
            "downloads": -1,
            "filename": "discord.py-self-2.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "617cd1496fd99458f4504d821fc98546",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.0",
            "size": 1031948,
            "upload_time": "2023-04-07T22:39:46",
            "upload_time_iso_8601": "2023-04-07T22:39:46.062661Z",
            "url": "https://files.pythonhosted.org/packages/f0/e1/cd9cb28e9cc061904f468ee690eb63ea0fceac56bb8481550527377b71b8/discord.py-self-2.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-04-07 22:39:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "dolfies",
    "github_project": "discord.py-self",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "discord.py-self"
}
        
Elapsed time: 0.07205s