Metadata-Version: 2.1
Name: m3u-maker
Version: 0.1.4
Summary: finds music files in directory and create a m3u playlist
Home-page: https://github.com/CastixGitHub/m3u_maker
Author: Castix
Author-email: castix@autistici.org
Project-URL: Bug Reports, https://github.com/CastixGitHub/m3u_maker/issues
Project-URL: Source, https://github.com/CastixGitHub/m3u_maker
Keywords: m3u m3u8 playlist
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
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 :: Only
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: test
License-File: LICENSE

# m3u maker

## Installation
This script doesn't have any dependencies except from python, so install python3.6+ before.
python2 is not supported

### with pip
```bash
pip install m3u-maker
m3u-maker ~/Music > out.m3u
```

#### available aliases
the best way to run is directly with: `python -m m3u_maker`

but the following aliases are available `m3u-maker`, `mkm3u`, `mkm3u8`

### manual
```bash
git clone https://github.com/CastixGitHub/m3u_maker
cd m3u_maker
python m3u_maker.py ~/Music > out.m3u
```

## Help menu
```
usage: 'm3u_maker [-h] [sources [sources ...]]

    Finds music files by extension (flac, ogg, oga, wav, mp3,
    aiff, aif, loss, m4a, aac, alac, mogg, opus. webm, mp4, wma, mpc)
    inside a folders and it's subdirectories, makes a m3u file
    without metadata
    

positional arguments:
  sources     
              Source directories that contains the music
              (subdirectories are included).
              We suggest to use an absolute path for better
              compatibility with players.
              If you want to use relative paths remember that them
              are relative to the location of the output m3u file.
              Defaults to the directory where the script is called
              from (`pwd`).

optional arguments:
  -h, --help  show this help message and exit

    Example Usage:
    python m3u_maker.py ~/Music > out.m3u
    Example with random order without duplicates:
    python m3u_maker.py ~/Music | uniq | shuf > out.m3u
```
## Testing & Development

after activating a virtualenv:

install the project with
```bash
pip install -e '.[test]'
```
run the tests with
```bash
pytest --cov=.
```

### release a new version on pypi

1. update the version number in setup.py
1. clean the old built `rm -rf dist`
1. build tarball and wheel with `python setup.py sdist bdist_wheel`
1. install twine `pip install twine`
1. upload with `twine upload dist/m3u_maker-*`
