lavaplay.py


Namelavaplay.py JSON
Version 1.0.12a0 PyPI version JSON
download
home_pagehttps://github.com/HazemMeqdad/lavaplay.py
SummaryIts a lavalink nodes manger to make a music bots for discord with python.
upload_time2023-06-10 08:24:31
maintainer
docs_urlNone
authorHazemMeqdad
requires_python
license
keywords lavalink discord discord-lavalink lavaplay lavaplay.py
VCS
bugtrack_url
requirements aiohttp
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <h1 align="center">
    <b>
        <a href="https://github.com/HazemMeqdad/lavaplay.py">
            lavaplay.py
        </a>
    </b>
</h1>


<p align="center">
    <a href="https://discord.gg/VcWRRphVQB">Support Guild</a> |
    <a href="https://github.com/HazemMeqdad/lavaplay.py/tree/main/examples">Examples</a> |
    <a href="https://lavaplay.readthedocs.io/en/latest/">Documentation</a> |
    <a href="https://github.com/HazemMeqdad/lavaplay.py">Source</a>
</p>

<br>

Its a lavalink nodes manger to make a music bots for discord with python.


# About

lavaplay.py is a nodes manager to connection with discord voice gateway, easy to create a music bot, you can use to anything async discord wrapper library

# Usage

example for create connecting with lavalink server using [hikari](https://github.com/hikari-py/hikari).

```python
import hikari
import lavaplay

bot = hikari.GatewayBot("token")

lavalink = lavaplay.Lavalink()
node = lavalink.create_node(
    host="localhost",
    port=2333,
    password="youshallnotpass",
    user_id=123
)

@bot.listen()
async def on_ready(event: hikari.ShardReadyEvent) -> None:
    node.connect()

bot.run()
```

examples for some methods.
```python
# Player object
player = node.get_player(guild_id)

# Auto search mix with track or query
await player.auto_search_tracks("Rick Astley")

# Play track
await player.play(track)

# Skip
await player.skip()

# Pause
await player.pause(stats)

# Volume
await player.volume(volume)
```

# Features

- [ ] Spotify support
- [x] new Rest api for lavalink support
- [x] connection handler
- [x] Support youtube playlist
- [x] Add example for other discord wrapper library

# Installation

```shell
# Linux/OS X
$ pip3 install -U lavaplay.py

# Windows
$ pip install -U lavaplay.py
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/HazemMeqdad/lavaplay.py",
    "name": "lavaplay.py",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "lavalink,discord,discord-lavalink,lavaplay,lavaplay.py",
    "author": "HazemMeqdad",
    "author_email": "hazemmeqdad@outlook.com",
    "download_url": "https://files.pythonhosted.org/packages/32/52/9bedd50f191a9595e56e98e6d3106268b1886c01f814d61a4c846fe9ecfd/lavaplay.py-1.0.12a0.tar.gz",
    "platform": null,
    "description": "<h1 align=\"center\">\r\n    <b>\r\n        <a href=\"https://github.com/HazemMeqdad/lavaplay.py\">\r\n            lavaplay.py\r\n        </a>\r\n    </b>\r\n</h1>\r\n\r\n\r\n<p align=\"center\">\r\n    <a href=\"https://discord.gg/VcWRRphVQB\">Support Guild</a> |\r\n    <a href=\"https://github.com/HazemMeqdad/lavaplay.py/tree/main/examples\">Examples</a> |\r\n    <a href=\"https://lavaplay.readthedocs.io/en/latest/\">Documentation</a> |\r\n    <a href=\"https://github.com/HazemMeqdad/lavaplay.py\">Source</a>\r\n</p>\r\n\r\n<br>\r\n\r\nIts a lavalink nodes manger to make a music bots for discord with python.\r\n\r\n\r\n# About\r\n\r\nlavaplay.py is a nodes manager to connection with discord voice gateway, easy to create a music bot, you can use to anything async discord wrapper library\r\n\r\n# Usage\r\n\r\nexample for create connecting with lavalink server using [hikari](https://github.com/hikari-py/hikari).\r\n\r\n```python\r\nimport hikari\r\nimport lavaplay\r\n\r\nbot = hikari.GatewayBot(\"token\")\r\n\r\nlavalink = lavaplay.Lavalink()\r\nnode = lavalink.create_node(\r\n    host=\"localhost\",\r\n    port=2333,\r\n    password=\"youshallnotpass\",\r\n    user_id=123\r\n)\r\n\r\n@bot.listen()\r\nasync def on_ready(event: hikari.ShardReadyEvent) -> None:\r\n    node.connect()\r\n\r\nbot.run()\r\n```\r\n\r\nexamples for some methods.\r\n```python\r\n# Player object\r\nplayer = node.get_player(guild_id)\r\n\r\n# Auto search mix with track or query\r\nawait player.auto_search_tracks(\"Rick Astley\")\r\n\r\n# Play track\r\nawait player.play(track)\r\n\r\n# Skip\r\nawait player.skip()\r\n\r\n# Pause\r\nawait player.pause(stats)\r\n\r\n# Volume\r\nawait player.volume(volume)\r\n```\r\n\r\n# Features\r\n\r\n- [ ] Spotify support\r\n- [x] new Rest api for lavalink support\r\n- [x] connection handler\r\n- [x] Support youtube playlist\r\n- [x] Add example for other discord wrapper library\r\n\r\n# Installation\r\n\r\n```shell\r\n# Linux/OS X\r\n$ pip3 install -U lavaplay.py\r\n\r\n# Windows\r\n$ pip install -U lavaplay.py\r\n```\r\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Its a lavalink nodes manger to make a music bots for discord with python.",
    "version": "1.0.12a0",
    "project_urls": {
        "Bug Reports": "https://github.com/HazemMeqdad/lavaplay.py/issues",
        "Documentation": "https://lavaplay.readthedocs.io/en/latest",
        "Homepage": "https://github.com/HazemMeqdad/lavaplay.py",
        "Source": "https://github.com/HazemMeqdad/lavaplay.py/"
    },
    "split_keywords": [
        "lavalink",
        "discord",
        "discord-lavalink",
        "lavaplay",
        "lavaplay.py"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ef9725da1e389a59b60ed09ea31de80e237592bbc3212ded789ac902bf5c88cb",
                "md5": "533b1a1870af98991f28dc3b32f824cc",
                "sha256": "58729191e3aed48eef9ecb0319ae44b2852ce3ea103a06a75c6ce6ca4eba6561"
            },
            "downloads": -1,
            "filename": "lavaplay.py-1.0.12a0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "533b1a1870af98991f28dc3b32f824cc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 19149,
            "upload_time": "2023-06-10T08:24:30",
            "upload_time_iso_8601": "2023-06-10T08:24:30.095496Z",
            "url": "https://files.pythonhosted.org/packages/ef/97/25da1e389a59b60ed09ea31de80e237592bbc3212ded789ac902bf5c88cb/lavaplay.py-1.0.12a0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "32529bedd50f191a9595e56e98e6d3106268b1886c01f814d61a4c846fe9ecfd",
                "md5": "2e3b88e2d13603a10d7be4e8723f5c40",
                "sha256": "af437aa28639653d6f12581c18a82c4a3c2a7d8db9e38c13f9e052c10a5b7b26"
            },
            "downloads": -1,
            "filename": "lavaplay.py-1.0.12a0.tar.gz",
            "has_sig": false,
            "md5_digest": "2e3b88e2d13603a10d7be4e8723f5c40",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 16091,
            "upload_time": "2023-06-10T08:24:31",
            "upload_time_iso_8601": "2023-06-10T08:24:31.787548Z",
            "url": "https://files.pythonhosted.org/packages/32/52/9bedd50f191a9595e56e98e6d3106268b1886c01f814d61a4c846fe9ecfd/lavaplay.py-1.0.12a0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-10 08:24:31",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "HazemMeqdad",
    "github_project": "lavaplay.py",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "aiohttp",
            "specs": []
        }
    ],
    "lcname": "lavaplay.py"
}
        
Elapsed time: 0.08316s