[](https://results.pre-commit.ci/latest/github/Drapersniper/Py-Lav/master)
[](https://github.com/Drapersniper/Py-Lav/blob/master/LICENSE)
[](https://discord.com/invite/Sjh2TSCYQB)
[](https://pypi.org/project/Py-Lav/)
[](https://pylav.readthedocs.io/en/latest/?badge=latest)
[](https://crowdin.com/project/pylav)
# 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.10+ (On initial release - during pre-alpha phase 3.9+)
- [Discord.py](https://github.com/Rapptz/discord.py) 2.0.0+ bot
### Environment Variables
Note - All environment variables except `PYLAV__LOGGER_PREFIX` can be configured from the `pylav.yaml` file which should reside in the home directory of the user running the bot.
An example of the file can be found at [pylav.example.yaml](./pylav.example.yaml), if you don't create the file yourself pylav will do so on the first run, and once the file exists it will be preferred over the Environment Variable set.
#### Required
- Env Vars to connect the lib to the PostgresSQL server
All Envvars default to AsyncPG [defaults](https://magicstack.github.io/asyncpg/current/api/index.html#connection)
- PYLAV__POSTGRES_PORT
- PYLAV__POSTGRES_PASSWORD
- PYLAV__POSTGRES_USER
- PYLAV__POSTGRES_DB
- PYLAV__POSTGRES_HOST
- Unix Socket env var.
- `PYLAV__POSTGRES_SOCKET` If this is provided `PYLAV__POSTGRES_HOST` and `PYLAV__POSTGRES_PORT` will be ignored.
#### Optional
- Env Vars to connect the lib cache to Redis, note if these are missing the library will default to PostgresSQL, therefore they are not necessary.
- This will be used by the aiohttp cached client session for storing cached responses for 1 day, this reduces stress on some of the requests the lib makes such as to RadioBrowser.
- PYLAV__REDIS_FULL_ADDRESS_RESPONSE_CACHE
- e.g. redis://[[username]:[password]]@localhost:6379/0
- e.g. unix://[[username]:[password]]@/path/to/socket.sock?db=0
- Misc
- PYLAV__LOGGER_PREFIX - Sets the logger prefix, defaults to None, or "red." if [redbot](https://github.com/Cog-Creators/Red-DiscordBot) is installed.
- PYLAV__JAVA_EXECUTABLE - Sets the Java executable to be used by PyLav for the managed Lavalink node
- PYLAV__USE_BUNDLED_EXTERNAL_PYLAV_NODE - Enabled the bundled PyLav external nodes, this is enabled by default as it is not recommended to disable this option.
- PYLAV__USE_BUNDLED_EXTERNAL_LAVA_LINK_NODE - Enabled the bundled lava.link node, this is disabled by default as it is not recommended to enable this option.
- Unmanaged External Node - If both PYLAV__EXTERNAL_UNMANAGED_HOST and PYLAV__EXTERNAL_UNMANAGED_PASSWORD are set then the managed node is not started up
- PYLAV__EXTERNAL_UNMANAGED_HOST - No Default - Required (Should not contain the protocol i.e "http" or "https", this is determined by PYLAV__EXTERNAL_UNMANAGED_SSL)
- PYLAV__EXTERNAL_UNMANAGED_PASSWORD - No Default - Required
- PYLAV__EXTERNAL_UNMANAGED_PORT - Defaults to 80
- PYLAV__EXTERNAL_UNMANAGED_SSL - Defaults to 0 (i.e False) - Possible values are 0 - 1
- Tasks Timers
- PYLAV__TASK_TIMER_UPDATE_BUNDLED_PLAYLISTS_DAYS: Defaults to 1 # How many days to wait between updates - Minimum 1 Day.
- PYLAV__TASK_TIMER_UPDATE_BUNDLED_EXTERNAL_PLAYLISTS_DAYS: Defaults to 7 # How many days to wait between updates - Minimum 7 Days.
- PYLAV__TASK_TIMER_UPDATE_EXTERNAL_PLAYLISTS_DAYS: Defaults to 7 # How many days to wait between updates - Minimum 7 Days.
---------------------------
## Supported sources
### [Built-in](https://github.com/freyacodes/Lavalink):
- youtube
- soundcloud
- twitch
- bandcamp
- vimeo
- http
- local
### With [LavaSrc](https://github.com/TopiSenpai/LavaSrc)
- spotify
- applemusic
- deezer
### With [DuncteBot-plugin](https://github.com/DuncteBot/skybot-lavalink-plugin):
- getyarn
- clypit
- tts
- pornhub
- reddit
- ocremix
- tiktok
- mixcloud
### With [Google Cloud TTS](https://github.com/DuncteBot/tts-plugin):
- gcloud-tts
### With [Sponsorblock-Plugin](https://github.com/Topis-Lavalink-Plugins/Sponsorblock-Plugin):
- sponsorblock
### With [Topis-Source-Managers-Plugin](https://github.com/Topis-Lavalink-Plugins/Topis-Source-Managers-Plugin) - Deprecated, use LavaSrc instead:
- spotify
- applemusic
## Supported Lavalink features
- Supports all features of [Lavalink](https://github.com/freyacodes/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)
Credits
---------------------------
- [Devoxin- Lavalink.py](https://github.com/Devoxin/Lavalink.py) for ideas for implementation.
- [globocom/m3u8](https://github.com/globocom/m3u8) for the M3U8 parser which I made asynchronous found in [m3u8_parser](./pylav/m3u8_parser).
- [andreztz/pyradios](https://github.com/andreztz/pyradios) for the radio parser which I made asynchronous found in [radio](./pylav/radio).
Raw data
{
"_id": null,
"home_page": "https://github.com/Drapersniper/PyLav",
"name": "Py-Lav",
"maintainer": "",
"docs_url": null,
"requires_python": "<3.11,>=3.10.0",
"maintainer_email": "",
"keywords": "",
"author": "Draper",
"author_email": "draper@draper.wtf",
"download_url": "https://files.pythonhosted.org/packages/cb/0f/5e8b87591cbf3cd18082a79691bbbc9d6cffa067b95a7b874364424d80fe/Py-Lav-0.11.20.0.tar.gz",
"platform": null,
"description": "[](https://results.pre-commit.ci/latest/github/Drapersniper/Py-Lav/master)\n[](https://github.com/Drapersniper/Py-Lav/blob/master/LICENSE)\n[](https://discord.com/invite/Sjh2TSCYQB)\n[](https://pypi.org/project/Py-Lav/)\n[](https://pylav.readthedocs.io/en/latest/?badge=latest)\n[](https://crowdin.com/project/pylav)\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.10+ (On initial release - during pre-alpha phase 3.9+)\n- [Discord.py](https://github.com/Rapptz/discord.py) 2.0.0+ bot\n\n### Environment Variables\nNote - All environment variables except `PYLAV__LOGGER_PREFIX` can be configured from the `pylav.yaml` file which should reside in the home directory of the user running the bot.\nAn example of the file can be found at [pylav.example.yaml](./pylav.example.yaml), if you don't create the file yourself pylav will do so on the first run, and once the file exists it will be preferred over the Environment Variable set.\n#### Required\n- Env Vars to connect the lib to the PostgresSQL server\n All Envvars default to AsyncPG [defaults](https://magicstack.github.io/asyncpg/current/api/index.html#connection)\n - PYLAV__POSTGRES_PORT\n - PYLAV__POSTGRES_PASSWORD\n - PYLAV__POSTGRES_USER\n - PYLAV__POSTGRES_DB\n - PYLAV__POSTGRES_HOST\n- Unix Socket env var.\n - `PYLAV__POSTGRES_SOCKET` If this is provided `PYLAV__POSTGRES_HOST` and `PYLAV__POSTGRES_PORT` will be ignored.\n#### Optional\n- Env Vars to connect the lib cache to Redis, note if these are missing the library will default to PostgresSQL, therefore they are not necessary.\n - This will be used by the aiohttp cached client session for storing cached responses for 1 day, this reduces stress on some of the requests the lib makes such as to RadioBrowser.\n - PYLAV__REDIS_FULL_ADDRESS_RESPONSE_CACHE\n - e.g. redis://[[username]:[password]]@localhost:6379/0\n - e.g. unix://[[username]:[password]]@/path/to/socket.sock?db=0\n- Misc\n - PYLAV__LOGGER_PREFIX - Sets the logger prefix, defaults to None, or \"red.\" if [redbot](https://github.com/Cog-Creators/Red-DiscordBot) is installed.\n - PYLAV__JAVA_EXECUTABLE - Sets the Java executable to be used by PyLav for the managed Lavalink node\n - PYLAV__USE_BUNDLED_EXTERNAL_PYLAV_NODE - Enabled the bundled PyLav external nodes, this is enabled by default as it is not recommended to disable this option.\n - PYLAV__USE_BUNDLED_EXTERNAL_LAVA_LINK_NODE - Enabled the bundled lava.link node, this is disabled by default as it is not recommended to enable this option.\n- Unmanaged External Node - If both PYLAV__EXTERNAL_UNMANAGED_HOST and PYLAV__EXTERNAL_UNMANAGED_PASSWORD are set then the managed node is not started up\n - PYLAV__EXTERNAL_UNMANAGED_HOST - No Default - Required (Should not contain the protocol i.e \"http\" or \"https\", this is determined by PYLAV__EXTERNAL_UNMANAGED_SSL)\n - PYLAV__EXTERNAL_UNMANAGED_PASSWORD - No Default - Required\n - PYLAV__EXTERNAL_UNMANAGED_PORT - Defaults to 80\n - PYLAV__EXTERNAL_UNMANAGED_SSL - Defaults to 0 (i.e False) - Possible values are 0 - 1\n- Tasks Timers\n - PYLAV__TASK_TIMER_UPDATE_BUNDLED_PLAYLISTS_DAYS: Defaults to 1 # How many days to wait between updates - Minimum 1 Day.\n - PYLAV__TASK_TIMER_UPDATE_BUNDLED_EXTERNAL_PLAYLISTS_DAYS: Defaults to 7 # How many days to wait between updates - Minimum 7 Days.\n - PYLAV__TASK_TIMER_UPDATE_EXTERNAL_PLAYLISTS_DAYS: Defaults to 7 # How many days to wait between updates - Minimum 7 Days.\n---------------------------\n## Supported sources\n### [Built-in](https://github.com/freyacodes/Lavalink):\n - youtube\n - soundcloud\n - twitch\n - bandcamp\n - vimeo\n - http\n - local\n### With [LavaSrc](https://github.com/TopiSenpai/LavaSrc)\n - spotify\n - applemusic\n - deezer\n### With [DuncteBot-plugin](https://github.com/DuncteBot/skybot-lavalink-plugin):\n - getyarn\n - clypit\n - tts\n - pornhub\n - reddit\n - ocremix\n - tiktok\n - mixcloud\n### With [Google Cloud TTS](https://github.com/DuncteBot/tts-plugin):\n - gcloud-tts\n### With [Sponsorblock-Plugin](https://github.com/Topis-Lavalink-Plugins/Sponsorblock-Plugin):\n - sponsorblock\n### With [Topis-Source-Managers-Plugin](https://github.com/Topis-Lavalink-Plugins/Topis-Source-Managers-Plugin) - Deprecated, use LavaSrc instead:\n - spotify\n - applemusic\n\n## Supported Lavalink features\n - Supports all features of [Lavalink](https://github.com/freyacodes/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\n\nCredits\n---------------------------\n- [Devoxin- Lavalink.py](https://github.com/Devoxin/Lavalink.py) for ideas for implementation.\n- [globocom/m3u8](https://github.com/globocom/m3u8) for the M3U8 parser which I made asynchronous found in [m3u8_parser](./pylav/m3u8_parser).\n- [andreztz/pyradios](https://github.com/andreztz/pyradios) for the radio parser which I made asynchronous found in [radio](./pylav/radio).\n",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "A Lavalink WebSocket & API wrapper for discord.py",
"version": "0.11.20.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "b024c7daee551b3c2bb4d8850f509973",
"sha256": "f9009ab86c9f98192dd94ee40ed064242a8d5174a4b1356d63d9abccf3ba8b1a"
},
"downloads": -1,
"filename": "Py_Lav-0.11.20.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b024c7daee551b3c2bb4d8850f509973",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11,>=3.10.0",
"size": 391983,
"upload_time": "2022-12-30T18:40:41",
"upload_time_iso_8601": "2022-12-30T18:40:41.679483Z",
"url": "https://files.pythonhosted.org/packages/18/12/ffda53790aaa95cd68acb8b8cdbeea3c8341dd5610c4d935a2512fede2c2/Py_Lav-0.11.20.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "12279e11189047dd19345bb402b3e4a8",
"sha256": "093343d7620eb0f98378333d3166bafcb9a1c4200137823f5b1665b6b9107509"
},
"downloads": -1,
"filename": "Py-Lav-0.11.20.0.tar.gz",
"has_sig": false,
"md5_digest": "12279e11189047dd19345bb402b3e4a8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>=3.10.0",
"size": 355054,
"upload_time": "2022-12-30T18:40:43",
"upload_time_iso_8601": "2022-12-30T18:40:43.273751Z",
"url": "https://files.pythonhosted.org/packages/cb/0f/5e8b87591cbf3cd18082a79691bbbc9d6cffa067b95a7b874364424d80fe/Py-Lav-0.11.20.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-30 18:40:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Drapersniper",
"github_project": "PyLav",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "py-lav"
}
JSON
