| Name | arrangio JSON |
| Version |
0.5.1
JSON |
| download |
| home_page | None |
| Summary | Arranges a set of songs in groups with similar total play time. |
| upload_time | 2024-10-04 10:59:12 |
| maintainer | None |
| docs_url | None |
| author | Frederico Martins |
| requires_python | <4,>=3.8 |
| license | MIT |
| keywords |
grouping
songs
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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](https://www.python.org/downloads/).
## Installation
The simplest way to install this tool is using pip:
```shell
pip3 install arrangio
```
## Usage
A simple example of how to use this tool:
```shell
arrangio --groups 2 --song song01:3m24s --song song02:4m01s --song song03:1m47s
```
List of all the options:
```shell
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](https://just.systems) 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:
```shell
just init
```
To build a Python package for this library use the following command:
```shell
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:
```shell
pip3 --quiet install dist/arrangio-*.whl
```
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request
Please read the [CONTRIBUTING.md](https://github.com/electric-mass/arrangio/blob/master/CONTRIBUTING.md)
file for more details on how to contribute to this project.
## Versioning
This project uses [SemVer](http://semver.org/) for versioning. For the versions
available, see the [tags on this repository](https://github.com/electric-mass/arrangio/tags).
## Authors
* **Frederico Martins** - [fscm](https://github.com/fscm)
See also the list of [contributors](https://github.com/electric-mass/arrangio/contributors)
who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/electric-mass/arrangio/blob/master/LICENSE)
file for details
Raw data
{
"_id": null,
"home_page": null,
"name": "arrangio",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.8",
"maintainer_email": null,
"keywords": "grouping, songs",
"author": "Frederico Martins",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ba/07/8a58f43b61a9de2c04b1d5b7be642a23b673a5de0a15b677154ae7158720/arrangio-0.5.1.tar.gz",
"platform": null,
"description": "# arrangio\n\nArranges a set of songs in groups with similar total play time.\n\n## Synopsis\n\nThis tool will try to arrange a set of songs into subsets of songs\n(groups) whose total play time will be the most sililar possible.\n\n## Prerequisites\n\nPython, version 3.8 or above, needs to be installed on your local\ncomputer.\n\n### Python 3.x\n\nPython version 3.8 or above is required for the tool to work. Python\nsetup can be found [here](https://www.python.org/downloads/).\n\n## Installation\n\nThe simplest way to install this tool is using pip:\n\n```shell\npip3 install arrangio\n```\n\n## Usage\n\nA simple example of how to use this tool:\n\n```shell\narrangio --groups 2 --song song01:3m24s --song song02:4m01s --song song03:1m47s\n```\n\nList of all the options:\n\n```shell\nusage: arrangio [-h] [-g [NUM]] [-q] -s LABEL:HHhMMmSSs [LABEL:HHhMMmSSs ...] [-v]\n\noptions:\n -h, --help show this help message and exit\n -g [NUM], --groups [NUM]\n number of groups to create (default: 2)\n -q, --quiet quiet mode (default: False)\n -s LABEL:HHhMMmSSs [LABEL:HHhMMmSSs ...], --song LABEL:HHhMMmSSs [LABEL:HHhMMmSSs ...]\n song information (e.g.: song01:00h03m27s) (default: None)\n -v, --version show program's version number and exit\n```\n\n## Build (from source)\n\n[just](https://just.systems) is used to automate several steps of the\ndevelopment process.\n\nAll of the commands described bellow are to be executed on the root folder\nof this project.\n\nA development environment can be created using the following command:\n\n```shell\njust init\n```\n\nTo build a Python package for this library use the following command:\n\n```shell\njust build\n```\n\nAfter this you should have a wheel file (`*.whl`) inside a folder called\n`dist`.\n\nThe library can be install using the wheel file and pip3:\n\n```shell\npip3 --quiet install dist/arrangio-*.whl\n```\n\n## Contributing\n\n1. Fork it!\n2. Create your feature branch: `git checkout -b my-new-feature`\n3. Commit your changes: `git commit -am 'Add some feature'`\n4. Push to the branch: `git push origin my-new-feature`\n5. Submit a pull request\n\nPlease read the [CONTRIBUTING.md](https://github.com/electric-mass/arrangio/blob/master/CONTRIBUTING.md)\nfile for more details on how to contribute to this project.\n\n## Versioning\n\nThis project uses [SemVer](http://semver.org/) for versioning. For the versions\navailable, see the [tags on this repository](https://github.com/electric-mass/arrangio/tags).\n\n## Authors\n\n* **Frederico Martins** - [fscm](https://github.com/fscm)\n\nSee also the list of [contributors](https://github.com/electric-mass/arrangio/contributors)\nwho participated in this project.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/electric-mass/arrangio/blob/master/LICENSE)\nfile for details\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Arranges a set of songs in groups with similar total play time.",
"version": "0.5.1",
"project_urls": {
"Documentation": "http://electric-mass.github.io/arrangio",
"Homepage": "https://github.com/electric-mass/arrangio",
"Source": "https://github.com/electric-mass/arrangio"
},
"split_keywords": [
"grouping",
" songs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f4426878a4e2d50bdfb3d2bc376db124447f0db78f45611665d4f14e7fdebc3b",
"md5": "493838cf70f722b1ef9585c6acc7e664",
"sha256": "57110130edcf8f8bc2d62dd49820cd2ebb052a1f5bf045fff17b9ab600e18803"
},
"downloads": -1,
"filename": "arrangio-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "493838cf70f722b1ef9585c6acc7e664",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.8",
"size": 9490,
"upload_time": "2024-10-04T10:59:10",
"upload_time_iso_8601": "2024-10-04T10:59:10.811539Z",
"url": "https://files.pythonhosted.org/packages/f4/42/6878a4e2d50bdfb3d2bc376db124447f0db78f45611665d4f14e7fdebc3b/arrangio-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba078a58f43b61a9de2c04b1d5b7be642a23b673a5de0a15b677154ae7158720",
"md5": "d9ddb3c4e0e0e9b0e84571f7bef3fc98",
"sha256": "742ef681832873ce456d1698017535cae07696171cac9bb65a17b6d4afff4456"
},
"downloads": -1,
"filename": "arrangio-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "d9ddb3c4e0e0e9b0e84571f7bef3fc98",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.8",
"size": 10920,
"upload_time": "2024-10-04T10:59:12",
"upload_time_iso_8601": "2024-10-04T10:59:12.403628Z",
"url": "https://files.pythonhosted.org/packages/ba/07/8a58f43b61a9de2c04b1d5b7be642a23b673a5de0a15b677154ae7158720/arrangio-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-04 10:59:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "electric-mass",
"github_project": "arrangio",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "arrangio"
}
