# afplay-py
A python wrapper and better CLI for the macOS tool `afplay` (audio-file player).
## Installation
From pip:
```shell
pip install afplay-py
```
From source (from the root project directory):
```shell
pip install .
```
## Quick Usage
### CLI
Play an audio file using the CLI:
```sh
afplay-py ~/path/to/file.mp3
```
**NOTE**: The intent is for this CLI to not have some of the problems the regular tool does.
### Python
Play an audio file using Python:
```python
from afplay import afplay
afplay("path/to/file.mp3", volume=2, time=100, leaks=True)
```
Check if `afplay` is installed:
```python
from afplay import is_installed
print(is_installed())
```
Raw data
{
"_id": null,
"home_page": "https://github.com/unparalleled-js/afplay-py",
"name": "afplay-py",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4",
"maintainer_email": "",
"keywords": "afplay,macos",
"author": "Juliya Smith <juliya@juliyasmith.com>",
"author_email": "juliya@juliyasmith.com",
"download_url": "https://files.pythonhosted.org/packages/06/4c/ddc6f5f20bcba3d1ca58e1f0f57f7794180e7fd51726d633bfb68d160d14/afplay-py-0.2.1.tar.gz",
"platform": null,
"description": "# afplay-py\n\nA python wrapper and better CLI for the macOS tool `afplay` (audio-file player).\n\n## Installation\n\nFrom pip:\n\n```shell\npip install afplay-py\n```\n\nFrom source (from the root project directory):\n\n```shell\npip install .\n```\n\n## Quick Usage\n\n### CLI\n\nPlay an audio file using the CLI:\n\n```sh\nafplay-py ~/path/to/file.mp3\n```\n\n**NOTE**: The intent is for this CLI to not have some of the problems the regular tool does.\n\n### Python\n\nPlay an audio file using Python:\n\n```python\nfrom afplay import afplay\n\nafplay(\"path/to/file.mp3\", volume=2, time=100, leaks=True)\n```\n\nCheck if `afplay` is installed:\n\n```python\nfrom afplay import is_installed\n\nprint(is_installed())\n```\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A wrapper around macOS afplay",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/unparalleled-js/afplay-py"
},
"split_keywords": [
"afplay",
"macos"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1048a71f4f7e05149e5eb846aa57177bc289733eaa883b4e418a5d0f454c66ef",
"md5": "a042e4d925ce68c2a5e93d6c56c9e455",
"sha256": "c2bbd2b7528394c6c43301e2db046b469cb0acd4689259e0a981f96908339646"
},
"downloads": -1,
"filename": "afplay_py-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a042e4d925ce68c2a5e93d6c56c9e455",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4",
"size": 7034,
"upload_time": "2023-09-14T04:14:35",
"upload_time_iso_8601": "2023-09-14T04:14:35.236865Z",
"url": "https://files.pythonhosted.org/packages/10/48/a71f4f7e05149e5eb846aa57177bc289733eaa883b4e418a5d0f454c66ef/afplay_py-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "064cddc6f5f20bcba3d1ca58e1f0f57f7794180e7fd51726d633bfb68d160d14",
"md5": "291e9b63c5c0dc160e340602d98c73ff",
"sha256": "db817726316940379789acf28835551585b4e65e23ca82d7d583bc684bf492aa"
},
"downloads": -1,
"filename": "afplay-py-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "291e9b63c5c0dc160e340602d98c73ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4",
"size": 2208213,
"upload_time": "2023-09-14T04:14:37",
"upload_time_iso_8601": "2023-09-14T04:14:37.059859Z",
"url": "https://files.pythonhosted.org/packages/06/4c/ddc6f5f20bcba3d1ca58e1f0f57f7794180e7fd51726d633bfb68d160d14/afplay-py-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-14 04:14:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "unparalleled-js",
"github_project": "afplay-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "afplay-py"
}
JSON
