Py-Lav


NamePy-Lav JSON
Version 1.14.6 PyPI version JSON
download
home_pagehttps://github.com/PyLav/PyLav
Summary A Lavalink WebSocket & API wrapper for discord.py
upload_time2024-04-18 13:23:16
maintainerNone
docs_urlNone
authorDraper
requires_python<3.12,>=3.11
licenseAGPL-3.0-or-later
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![GitHub license](https://img.shields.io/github/license/PyLav/PyLav.svg)](https://github.com/PyLav/PyLav/blob/develop/LICENSE)
[![Support Server](https://img.shields.io/discord/970987707834720266)](https://discord.com/invite/vnmcXqtgeY)
[![PyPi](https://img.shields.io/pypi/v/Py-Lav?style=plastic)](https://pypi.org/project/Py-Lav/)
[![Crowdin](https://badges.crowdin.net/pylav/localized.svg)](https://crowdin.com/project/pylav)
[![Documentation Status](https://readthedocs.org/projects/pylav/badge/?version=stable)](https://pylav.readthedocs.io/en/stable/?badge=stable)


# Documentation
### Installation
 - [Click Here](SETUP.md)
---------------------------
### Requirements
- PostgresSQL 14 server
  - MacOS: [PostgresSQL](https://www.postgresql.org/download/macosx/)
  - Windows: [PostgresSQL](https://www.postgresql.org/download/windows/)
  - Linux: [PostgresSQL](https://www.postgresql.org/download/linux/)
- Python 3.11
- [Discord.py](https://github.com/Rapptz/discord.py) 2.1.0+ bot
- [Lavalink](https://github.com/lavalink-devs/Lavalink) v4.0.0+ server
---------------------------
## Supported sources
### [Built-in](https://github.com/lavalink-devs/Lavalink):
  - youtube
  - soundcloud
  - bandcamp
  - twitch
  - vimeo
  - http
  - local
### With [LavaSrc](https://github.com/topi314/LavaSrc)
  - spotify
  - applemusic
  - deezer
  - youtube
### With [DuncteBot-plugin](https://github.com/DuncteBot/skybot-lavalink-plugin):
  - getyarn.io
  - clypit
  - tts
  - pornhub
  - reddit
  - ocremix
  - tiktok
  - mixcloud
  - soundgasm
### With [Google Cloud TTS](https://github.com/DuncteBot/tts-plugin):
  - gcloud-tts
### With [Sponsorblock-Plugin](https://github.com/topi314/Sponsorblock-Plugin):
  - sponsorblock
### With [LavaSearch](https://github.com/topi314/LavaSearch):

## Supported Lavalink features
  - Supports all features of [Lavalink](https://github.com/lavalink-devs/Lavalink)
    - Filters
    - IP Rotation
    - Plug-ins

Features
---------------------------
- Multiple node support
  - Node region assignment based on IP
- Track cache for the last 30 days to reduce the number of duplicated queries
- Managed local node with auto-restart and auto update
- Many helper methods and functions
- Support for multiple cogs to access the library at once
- Playlists and EQ saved at a library level to be shared with cogs
- Player state persistence
    - Upon library state being shutdown all player states are saved and restored on library startup
- History of played tracks available for players
- RadioBrowser.org API to retrieve radio stations available for players
- M3U, PLS and PYLAV text file parser to convert contents into a playlist (p.s. Lavalink must support the format/coded of files still)

System Requirements
------------------------------------
With a locally hosted Postgres server and locally hosted/managed lavalink node (**recommended - Best performance**):
- CPU: 3 cores or more
- RAM: 4GB or more
- Disk Space: 10GB or more (NVME Ideally, SSD OK)

With a locally hosted Postgres server and externally hosted lavalink node (Okay performance):
- CPU: 2 cores or more
- RAM: 3GB or more
- Disk Space: 10GB or more (NVME Ideally, SSD OK)

With an externally hosted Postgres server and locally hosted/managed lavalink node (Poor performance):
- CPU: 2 cores or more
- RAM: 2GB or more
- Disk Space: 10GB or more (SSD)

With an externally hosted Postgres server and externally hosted lavalink node (Worst performance):
- CPU: 1 cores or more
- RAM: 1GB or more
- Disk Space: 10GB or more (SSD)

Credits
---------------------------
- [Topi](https://github.com/topi314) for all the work done to Lavalink and implementing direct requests to make PyLav even better.
- [Devoxin - Lavalink.py](https://github.com/Devoxin/Lavalink.py) for the original ideas for implementation.
- [Ryan](https://github.com/ryan5453) for the amazing [Lyrics API](https://flowery.pw) used for lyrics.
- [globocom/m3u8](https://github.com/globocom/m3u8) for the M3U8 parser which I made asynchronous found in [m3u8_parser](pylav/extension/m3u).
- [andreztz/pyradios](https://github.com/andreztz/pyradios) for the radio parser which I made asynchronous found in [radio](pylav/extension/radio).
- [Lifeismana](https://github.com/Lifeismana) for the custom Red-DiscordBot docker image which added Python3.11 support until Phasecore's image is updated.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/PyLav/PyLav",
    "name": "Py-Lav",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.12,>=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": "Draper",
    "author_email": "27962761+Drapersniper@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/59/a7/78e33e522305ba23b058c4ffe7d5d71ede36fae01f10bcdd4d876767161f/py_lav-1.14.6.tar.gz",
    "platform": null,
    "description": "[![GitHub license](https://img.shields.io/github/license/PyLav/PyLav.svg)](https://github.com/PyLav/PyLav/blob/develop/LICENSE)\n[![Support Server](https://img.shields.io/discord/970987707834720266)](https://discord.com/invite/vnmcXqtgeY)\n[![PyPi](https://img.shields.io/pypi/v/Py-Lav?style=plastic)](https://pypi.org/project/Py-Lav/)\n[![Crowdin](https://badges.crowdin.net/pylav/localized.svg)](https://crowdin.com/project/pylav)\n[![Documentation Status](https://readthedocs.org/projects/pylav/badge/?version=stable)](https://pylav.readthedocs.io/en/stable/?badge=stable)\n\n\n# Documentation\n### Installation\n - [Click Here](SETUP.md)\n---------------------------\n### Requirements\n- PostgresSQL 14 server\n  - MacOS: [PostgresSQL](https://www.postgresql.org/download/macosx/)\n  - Windows: [PostgresSQL](https://www.postgresql.org/download/windows/)\n  - Linux: [PostgresSQL](https://www.postgresql.org/download/linux/)\n- Python 3.11\n- [Discord.py](https://github.com/Rapptz/discord.py) 2.1.0+ bot\n- [Lavalink](https://github.com/lavalink-devs/Lavalink) v4.0.0+ server\n---------------------------\n## Supported sources\n### [Built-in](https://github.com/lavalink-devs/Lavalink):\n  - youtube\n  - soundcloud\n  - bandcamp\n  - twitch\n  - vimeo\n  - http\n  - local\n### With [LavaSrc](https://github.com/topi314/LavaSrc)\n  - spotify\n  - applemusic\n  - deezer\n  - youtube\n### With [DuncteBot-plugin](https://github.com/DuncteBot/skybot-lavalink-plugin):\n  - getyarn.io\n  - clypit\n  - tts\n  - pornhub\n  - reddit\n  - ocremix\n  - tiktok\n  - mixcloud\n  - soundgasm\n### With [Google Cloud TTS](https://github.com/DuncteBot/tts-plugin):\n  - gcloud-tts\n### With [Sponsorblock-Plugin](https://github.com/topi314/Sponsorblock-Plugin):\n  - sponsorblock\n### With [LavaSearch](https://github.com/topi314/LavaSearch):\n\n## Supported Lavalink features\n  - Supports all features of [Lavalink](https://github.com/lavalink-devs/Lavalink)\n    - Filters\n    - IP Rotation\n    - Plug-ins\n\nFeatures\n---------------------------\n- Multiple node support\n  - Node region assignment based on IP\n- Track cache for the last 30 days to reduce the number of duplicated queries\n- Managed local node with auto-restart and auto update\n- Many helper methods and functions\n- Support for multiple cogs to access the library at once\n- Playlists and EQ saved at a library level to be shared with cogs\n- Player state persistence\n    - Upon library state being shutdown all player states are saved and restored on library startup\n- History of played tracks available for players\n- RadioBrowser.org API to retrieve radio stations available for players\n- M3U, PLS and PYLAV text file parser to convert contents into a playlist (p.s. Lavalink must support the format/coded of files still)\n\nSystem Requirements\n------------------------------------\nWith a locally hosted Postgres server and locally hosted/managed lavalink node (**recommended - Best performance**):\n- CPU: 3 cores or more\n- RAM: 4GB or more\n- Disk Space: 10GB or more (NVME Ideally, SSD OK)\n\nWith a locally hosted Postgres server and externally hosted lavalink node (Okay performance):\n- CPU: 2 cores or more\n- RAM: 3GB or more\n- Disk Space: 10GB or more (NVME Ideally, SSD OK)\n\nWith an externally hosted Postgres server and locally hosted/managed lavalink node (Poor performance):\n- CPU: 2 cores or more\n- RAM: 2GB or more\n- Disk Space: 10GB or more (SSD)\n\nWith an externally hosted Postgres server and externally hosted lavalink node (Worst performance):\n- CPU: 1 cores or more\n- RAM: 1GB or more\n- Disk Space: 10GB or more (SSD)\n\nCredits\n---------------------------\n- [Topi](https://github.com/topi314) for all the work done to Lavalink and implementing direct requests to make PyLav even better.\n- [Devoxin - Lavalink.py](https://github.com/Devoxin/Lavalink.py) for the original ideas for implementation.\n- [Ryan](https://github.com/ryan5453) for the amazing [Lyrics API](https://flowery.pw) used for lyrics.\n- [globocom/m3u8](https://github.com/globocom/m3u8) for the M3U8 parser which I made asynchronous found in [m3u8_parser](pylav/extension/m3u).\n- [andreztz/pyradios](https://github.com/andreztz/pyradios) for the radio parser which I made asynchronous found in [radio](pylav/extension/radio).\n- [Lifeismana](https://github.com/Lifeismana) for the custom Red-DiscordBot docker image which added Python3.11 support until Phasecore's image is updated.\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0-or-later",
    "summary": " A Lavalink WebSocket & API wrapper for discord.py",
    "version": "1.14.6",
    "project_urls": {
        "Bug Tracker": "https://github.com/PyLav/PyLav/issues",
        "Documentation": "https://pylav.readthedocs.io/en/latest/",
        "Homepage": "https://github.com/PyLav/PyLav",
        "Repository": "https://github.com/PyLav/PyLav"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8d5689aa82be66dddf498a2acf22ec8088230d51a78358d5e659e0cf7e06c155",
                "md5": "5a816eb7f039d1cc5f8a1e90c101bce4",
                "sha256": "ec1f9f4ced6bf49ade175af149d4a8f30de95c4710e5095e22f9e387de56fe10"
            },
            "downloads": -1,
            "filename": "py_lav-1.14.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5a816eb7f039d1cc5f8a1e90c101bce4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.12,>=3.11",
            "size": 1935715,
            "upload_time": "2024-04-18T13:23:13",
            "upload_time_iso_8601": "2024-04-18T13:23:13.120003Z",
            "url": "https://files.pythonhosted.org/packages/8d/56/89aa82be66dddf498a2acf22ec8088230d51a78358d5e659e0cf7e06c155/py_lav-1.14.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "59a778e33e522305ba23b058c4ffe7d5d71ede36fae01f10bcdd4d876767161f",
                "md5": "db31cbb600e7a70629d35a7f2cc5c88b",
                "sha256": "e291492191c1717dcae44fac033111764c18ceb4170a222edf733edcaf929a4d"
            },
            "downloads": -1,
            "filename": "py_lav-1.14.6.tar.gz",
            "has_sig": false,
            "md5_digest": "db31cbb600e7a70629d35a7f2cc5c88b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.12,>=3.11",
            "size": 762853,
            "upload_time": "2024-04-18T13:23:16",
            "upload_time_iso_8601": "2024-04-18T13:23:16.599060Z",
            "url": "https://files.pythonhosted.org/packages/59/a7/78e33e522305ba23b058c4ffe7d5d71ede36fae01f10bcdd4d876767161f/py_lav-1.14.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-18 13:23:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "PyLav",
    "github_project": "PyLav",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "py-lav"
}
        
Elapsed time: 0.24757s