Skip to main content

A library to easily manage your playlists in python

Project description

easy-playlist

A library to easily manage yours playlists in python

Getting started

  1. Installation
  2. Usages
  3. Code example
  4. Documentation

Installation

This library will work with python 3.6+

PyPi : pip install easy-playlist

GitHub : Github

Usages

This library will work with any .mp3 files It's was desinged to work with bots in general

Code example

Simple tasks

from easy_playlist import Playlists

pls = Playlists()
pl = pls.add_playlist("test")
# pl = pls.get_playlist("test")

# add music to your playlist
pl.add_music("path_to_music.mp3")
pl.add_music(["path_to_music.mp3", "path_to_other_music.mp3"])

# trigger the timer
# this will take the first song of the playlist
pl.play()

# pause the timer
pl.pause()

# resume the timer
pl.resume()

# stop the current music and trigger the timer for the next one
pl.next()

# stop the current music and trigger the timer for the previous one
pl.previous()

# stop the timer and the music
pl.stop()

# IMPORTANT
# when you don't need to use the playlist anymore do this
# this library use a thread to calculate the time
pl.exit()

To make it work with a bot

from easy_playlist import Playlists

# any bot library
bot = Bot()
pls = Playlists()
pl = pls.add_playlist("test")

# pl = pls.get_playlist("test")


# code example


@bot.command()
def add_music(music):
	pl.add_music(music)


@bot.command()
def pause():
	pl.pause()
	bot.pause_music()


@bot.command()
def resume():
	pl.resume()
	bot.resume_music()


@bot.command()
def play(music):
	pl.play(music)
	bot.play_music(music)


@pl.on_music_over()
def music_over(data):
	print(f"{data.playlist.name} {data.music.name} is over, playing next now")
	pl.next()
	bot.play_music(pl.get_current().file)

An other code to explain

pl = Playlists()
pl1 = pl.add_playlist(name="test1", playlist=["music/bip1.mp3", "music/bip2.mp3"])
pl2 = pl.add_playlist(name="test2", playlist=["music/bip1.mp3", "music/bip2.mp3"])
pl.add_music("test1", "music/bip3.mp3")

# pl1 = pl.get_playlist("test1")
# pl2 = pl.get_playlist("test2")

pl1.play()
pl2.play()

print("starting...")


@pl.on_music_over()
def music_over(data):
    print(f"[{data.playlist.name}] {data.music.name} is over, next song now!")

    if data.playlist.is_over():
        print(f"Playlist {data.playlist.name} is over")
        data.playlist.clear()
        return

    data.playlist.next()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

easy_playlist-1.8.0.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

easy_playlist-1.8.0-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file easy_playlist-1.8.0.tar.gz.

File metadata

  • Download URL: easy_playlist-1.8.0.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for easy_playlist-1.8.0.tar.gz
Algorithm Hash digest
SHA256 b3f24321c88d0034cfa87421ce26336180e5efd00ea4d0ec798bc5fcc923e8d5
MD5 ee87e88235070454943847575bd92335
BLAKE2b-256 18d53aaadb7ed5204f368abd63030e6b8f0e292b170ccedb724b940e63a4c162

See more details on using hashes here.

File details

Details for the file easy_playlist-1.8.0-py3-none-any.whl.

File metadata

  • Download URL: easy_playlist-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for easy_playlist-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dccdf358060020387fe7511369eb8e799576876c525da6e54da3e6ee417361b4
MD5 984ac54c1431f7cf78b17957a5b40fc7
BLAKE2b-256 b26f74986c67fdaab978d7c427703fb235a83870165352c0691c28986cd9bc04

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page