# Polybeat
https://github.com/chunribu/polybeat/assets/57521167/1bad0cd3-3feb-4222-8fea-8398ac4c3689
## Installation
```shell
# first, install manim from conda-forge channel
conda install -c conda-forge manim
# then install polybeat from pypi
pip install polybeat
```
## Usage
```python
# step 1: import module
from polybeat import play
# step 2:
# primary usage
play([3,4,12])
# advanced usage
play(
rhythms=[3,4,6,12],
custom_order=None,
colors=[RED,YELLOW,BLUE,GREEN],
sounds=['kick_drum','open_conga','side_stick','low_bongo'],
volumes=[0,-2,-6,-4],
cycle_time=1.8,
dot_radius=0.16,
width_range=[2.5,3.5],
preview=True,
)
```
`custom_order` is None by default, which equals [0,1,2,3] in this case.
`colors` should be a list of variables supported by manim or hex number strings, e.g. ['#3ec1d3', '#f6f7d7', '#ff9a00', '#ff165d'].
`sounds` can be paths to custom audio files, or just leave it default.
`cycle_time` has an effect on speed.
`preview` means you want the video to auto play or not after rendering.
>It's safe to use default parameters when the number of beats is 4 or less
Raw data
{
"_id": null,
"home_page": "https://github.com/chunribu/polybeat/",
"name": "polybeat",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "polybeat polyrhythm pccfs",
"author": "Jian Jiang",
"author_email": "pccfreespace@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f9/d8/6564cc3bafd4e8646410715035c0fec161f9ddbcf5cb0c68405b63f2f6c3/polybeat-1.0.0.tar.gz",
"platform": null,
"description": "# Polybeat\n\n\n\nhttps://github.com/chunribu/polybeat/assets/57521167/1bad0cd3-3feb-4222-8fea-8398ac4c3689\n\n\n\n## Installation\n```shell\n# first, install manim from conda-forge channel\nconda install -c conda-forge manim\n\n# then install polybeat from pypi\npip install polybeat\n```\n\n## Usage\n```python\n# step 1: import module\nfrom polybeat import play\n\n# step 2:\n# primary usage\nplay([3,4,12])\n\n# advanced usage\nplay(\n rhythms=[3,4,6,12],\n custom_order=None,\n colors=[RED,YELLOW,BLUE,GREEN],\n sounds=['kick_drum','open_conga','side_stick','low_bongo'],\n volumes=[0,-2,-6,-4],\n cycle_time=1.8,\n dot_radius=0.16,\n width_range=[2.5,3.5],\n preview=True,\n)\n```\n\n`custom_order` is None by default, which equals [0,1,2,3] in this case.\n\n`colors` should be a list of variables supported by manim or hex number strings, e.g. ['#3ec1d3', '#f6f7d7', '#ff9a00', '#ff165d'].\n\n`sounds` can be paths to custom audio files, or just leave it default.\n\n`cycle_time` has an effect on speed.\n\n`preview` means you want the video to auto play or not after rendering.\n\n>It's safe to use default parameters when the number of beats is 4 or less\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A toy for visualizing polyrhythms",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/chunribu/polybeat/"
},
"split_keywords": [
"polybeat",
"polyrhythm",
"pccfs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef0d0d725b4c45866555c513055125d48ea475fa5817c932540998b4a6ff45cf",
"md5": "be86b06800d3868842bdf0753ae45070",
"sha256": "496a22cae72235b80549df68f67eab2ac7af51da9541346132f0ac53ceffc03d"
},
"downloads": -1,
"filename": "polybeat-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be86b06800d3868842bdf0753ae45070",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 431481,
"upload_time": "2023-06-15T20:29:18",
"upload_time_iso_8601": "2023-06-15T20:29:18.197769Z",
"url": "https://files.pythonhosted.org/packages/ef/0d/0d725b4c45866555c513055125d48ea475fa5817c932540998b4a6ff45cf/polybeat-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f9d86564cc3bafd4e8646410715035c0fec161f9ddbcf5cb0c68405b63f2f6c3",
"md5": "b377e0d528c428df44f39042aac57727",
"sha256": "17fc46568071985446294b703696697778954f2a8ee62577563e46a6dc3e9a68"
},
"downloads": -1,
"filename": "polybeat-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "b377e0d528c428df44f39042aac57727",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 436172,
"upload_time": "2023-06-15T20:29:20",
"upload_time_iso_8601": "2023-06-15T20:29:20.955350Z",
"url": "https://files.pythonhosted.org/packages/f9/d8/6564cc3bafd4e8646410715035c0fec161f9ddbcf5cb0c68405b63f2f6c3/polybeat-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-15 20:29:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chunribu",
"github_project": "polybeat",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "polybeat"
}
JSON
