arrangio

Arranges a set of songs in groups with similar total play time.

Synopsis

This tool will try to arrange a set of songs into subsets of songs (groups) whose total play time will be the most sililar possible.

Prerequisites

Python, version 3.8 or above, needs to be installed on your local computer.

Python 3.x

Python version 3.8 or above is required for the tool to work. Python setup can be found here.

Installation

The simplest way to install this tool is using pip:

pip3 install arrangio

Usage

A simple example of how to use this tool:

arrangio --groups 2 --song song01:3m24s --song song02:4m01s  --song song03:1m47s

List of all the options:

usage: arrangio [-h] [-g [NUM]] [-q] -s LABEL:HHhMMmSSs [LABEL:HHhMMmSSs ...] [-v]

options:
  -h, --help            show this help message and exit
  -g [NUM], --groups [NUM]
                        number of groups to create (default: 2)
  -q, --quiet           quiet mode (default: False)
  -s LABEL:HHhMMmSSs [LABEL:HHhMMmSSs ...], --song LABEL:HHhMMmSSs [LABEL:HHhMMmSSs ...]
                        song information (e.g.: song01:00h03m27s) (default: None)
  -v, --version         show program's version number and exit

Build (from source)

just is used to automate several steps of the development process.

All of the commands described bellow are to be executed on the root folder of this project.

A development environment can be created using the following command:

just init

To build a Python package for this library use the following command:

just build

After this you should have a wheel file (*.whl) inside a folder called dist.

The library can be install using the wheel file and pip3:

pip3 --quiet install dist/arrangio-*.whl

Contributing

Fork it!
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -am 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request

Please read the CONTRIBUTING.md file for more details on how to contribute to this project.

Versioning

This project uses SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Frederico Martins - fscm

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

electric-mass/arrangio