Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Drapersniper/PyLav

A Lavalink wrapper library to be used by discord-py bots. Docs at: https://pylav.readthedocs.io/
https://github.com/Drapersniper/PyLav

discord-py hacktoberfest lavalink python red-discordbot

Last synced: 6 days ago
JSON representation

A Lavalink wrapper library to be used by discord-py bots. Docs at: https://pylav.readthedocs.io/

Host: GitHub
URL: https://github.com/Drapersniper/PyLav
Owner: PyLav
License: agpl-3.0
Created: 2022-04-11T12:51:17.000Z (almost 3 years ago)
Default Branch: develop
Last Pushed: 2024-10-29T05:32:07.000Z (4 months ago)
Last Synced: 2024-10-29T20:35:44.541Z (3 months ago)
Topics: discord-py, hacktoberfest, lavalink, python, red-discordbot
Language: Python
Homepage: https://pylav.readthedocs.io/
Size: 12.1 MB
Stars: 18
Watchers: 3
Forks: 8
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-discord - PyLav - A multifunctional Lavalink wrapper library for Discord.py. (Misc Resources)

README

        [![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 (Deprecated with LL 4.0.5)

  - soundcloud

  - bandcamp

  - twitch

  - vimeo

  - http

  - local

### With [YouTube-plugin](https://github.com/lavalink-devs/youtube-source):

- youtube

### With [LavaSrc](https://github.com/topi314/LavaSrc)

  - spotify

  - applemusic

  - deezer

  - youtube

  - flowery-tts

### 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):

### With [LavaLyrics](https://github.com/topi314/LavaLyrics):

## 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.

- [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.