Metadata-Version: 2.1
Name: PlaySongs
Version: 2024.1.0.0
Summary: Play MP3 files from a directory.
Home-page: https://gitlab.com/fer1035_python/modules/pypi-playsongs
License: GPL-2.0-only
Keywords: music,MP3
Author: Ahmad Ferdaus Abd Razak
Author-email: ahmad.ferdaus.abd.razak@ni.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: playsound (>=1.3.0,<2.0.0)
Requires-Dist: pyobjc (>=9.0,<10.0)
Project-URL: Repository, https://gitlab.com/fer1035_python/modules/pypi-playsongs
Description-Content-Type: text/x-rst

=============
**playsongs**
=============

Overview
--------

Play MP3s from a specified directory.

Prerequisites
-------------

- *Python >= 3.6*
- *playsound >= 1.2.2* (installed as a dependency)
- *pyobjc >= 7.1* (installed as a dependency)
- **CAVEAT**: Due to *playsound* limitations, directory and filenames with spaces are not allowed.

Required (Positional) Arguments
-------------------------------

- Position 1: /path/to/mp3/files

Optional (Keyword) Arguments
----------------------------

- repeat
    - Description: Number of times to repeat the whole collection.
    - Type: Integer
    - Default: 0
- shuffle
    - Description: Select whether to shuffle the list of songs being played.
    - Type: Boolean
    - Default: False

Usage
-----

Installation:

.. code-block:: BASH

   pip3 install playsongs
   # or
   python3 -m pip install playsongs

In Python3:

.. code-block:: BASH

   from playsongs import PlaySongs
   PlaySongs('/home/username/Music', repeat = 10000000, shuffle = True)

In BASH:

.. code-block:: BASH

   python3 -c "from playsongs import PlaySongs; PlaySongs('/home/username/Music', repeat = 10000000, shuffle = True)"

