# chimed - wind chimes in your UNIX environments
The `chimed` daemon is an equivalent of a wind chime in a Linux system. It
provides a way for other programs to create various sounds with simple
interfaces - interrupt signals, UDP or TCP packets, UNIX sockets.
## Installation
The `chimed` installation requires `libasound2` development files, needed to
build the `simpleaudio` Python module.
sudo apt install libasound2-dev
You can install `chimed` from source in editable mode, if you want to work on it:
git clone https://github.com/drybjed/chimed ~/src/github.com/drybjed/chimed
pipx install --editable ~/src/github.com/drybjed/chimed
You can also install `chimed` from PyPI:
pipx install chimed
## Usage
After installation, run the daemon in a terminal window:
chimed serve
You can send commands to it using a FIFO file:
# Play a bell sound
echo "chime" >> $XDG_RUNTIME_DIR/chimed/fifo
The default installation includes a set of chimes and a corresponding
configuration for `vim` editor. You can check the `lib/vim/vimrc` file in the
repository to see an example configuration you need to include in your
`~/.vimrc` configuration to integrate with `chimed`. There's also an example
`systemd` unit file available, to run `chimed` as an user daemon.
The internal configuration can be viewed using:
chimed config get
You can put YAML, TOML and JSON files in the `~/.config/chimed/conf.d/`
directory to add or modify configuration options. Currently there's not much
configuration to be done, a lot of things need to be implemented, so stay
tuned.
## Copyright
Copyright (C) 2022-2024 Maciej Delmanowski <drybjed@gmail.com>
## Attribution
This software includes sounds from [freesound.org](https://freesound.org/):
- ["richcraft chime 4"](https://freesound.org/people/richcraftstudios/sounds/454610/) by
[richcraftstudios](https://freesound.org/people/richcraftstudios/), licensed
under CCBY 3.0.
- ["Typewriter ding_near_mono"](https://freesound.org/people/_stubb/sounds/406243/) by
[_stubb](https://freesound.org/people/_stubb/), licensed under CC0.
- ["Beep 03 Single"](https://freesound.org/people/PaulMorek/sounds/330050/) by
[PaulMorek](https://freesound.org/people/PaulMorek/), licensed under CC0.
- ["Beep 04 Positive"](https://freesound.org/people/PaulMorek/sounds/330048/) by
[PaulMorek](https://freesound.org/people/PaulMorek/), licensed under CC0.
- ["Click 02 Double"](https://freesound.org/people/PaulMorek/sounds/330076/) by
[PaulMorek](https://freesound.org/people/PaulMorek/), licensed under CC0.
- ["Click 02 Single"](https://freesound.org/people/PaulMorek/sounds/330075/) by
[PaulMorek](https://freesound.org/people/PaulMorek/), licensed under CC0.
- ["Swish 01"](https://freesound.org/people/PaulMorek/sounds/330066/) by
[PaulMorek](https://freesound.org/people/PaulMorek/), licensed under CC0.
- ["e key"](https://freesound.org/people/uEffects/sounds/180998/) by
[uEffects](https://freesound.org/people/uEffects/), licensed under CC0.
- ["l key"](https://freesound.org/people/uEffects/sounds/181003/) by
[uEffects](https://freesound.org/people/uEffects/), licensed under CC0.
- ["s key"](https://freesound.org/people/uEffects/sounds/181002/) by
[uEffects](https://freesound.org/people/uEffects/), licensed under CC0.
Raw data
{
"_id": null,
"home_page": "https://github.com/drybjed/chimed",
"name": "chimed",
"maintainer": null,
"docs_url": null,
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,<4,>=2.7",
"maintainer_email": null,
"keywords": "audio chime",
"author": "Maciej Delmanowski",
"author_email": "drybjed@gmail.com",
"download_url": "https://github.com/drybjed/chimed/archive/v0.1.1.tar.gz",
"platform": null,
"description": "# chimed - wind chimes in your UNIX environments\n\nThe `chimed` daemon is an equivalent of a wind chime in a Linux system. It\nprovides a way for other programs to create various sounds with simple\ninterfaces - interrupt signals, UDP or TCP packets, UNIX sockets.\n\n## Installation\n\nThe `chimed` installation requires `libasound2` development files, needed to\nbuild the `simpleaudio` Python module.\n\n sudo apt install libasound2-dev\n\nYou can install `chimed` from source in editable mode, if you want to work on it:\n\n git clone https://github.com/drybjed/chimed ~/src/github.com/drybjed/chimed\n pipx install --editable ~/src/github.com/drybjed/chimed\n\nYou can also install `chimed` from PyPI:\n\n pipx install chimed\n\n## Usage\n\nAfter installation, run the daemon in a terminal window:\n\n chimed serve\n\nYou can send commands to it using a FIFO file:\n\n # Play a bell sound\n echo \"chime\" >> $XDG_RUNTIME_DIR/chimed/fifo\n\nThe default installation includes a set of chimes and a corresponding\nconfiguration for `vim` editor. You can check the `lib/vim/vimrc` file in the\nrepository to see an example configuration you need to include in your\n`~/.vimrc` configuration to integrate with `chimed`. There's also an example\n`systemd` unit file available, to run `chimed` as an user daemon.\n\nThe internal configuration can be viewed using:\n\n chimed config get\n\nYou can put YAML, TOML and JSON files in the `~/.config/chimed/conf.d/`\ndirectory to add or modify configuration options. Currently there's not much\nconfiguration to be done, a lot of things need to be implemented, so stay\ntuned.\n\n## Copyright\n\nCopyright (C) 2022-2024 Maciej Delmanowski <drybjed@gmail.com>\n\n## Attribution\n\nThis software includes sounds from [freesound.org](https://freesound.org/):\n\n- [\"richcraft chime 4\"](https://freesound.org/people/richcraftstudios/sounds/454610/) by\n [richcraftstudios](https://freesound.org/people/richcraftstudios/), licensed\n under CCBY 3.0.\n\n- [\"Typewriter ding_near_mono\"](https://freesound.org/people/_stubb/sounds/406243/) by\n [_stubb](https://freesound.org/people/_stubb/), licensed under CC0.\n\n- [\"Beep 03 Single\"](https://freesound.org/people/PaulMorek/sounds/330050/) by\n [PaulMorek](https://freesound.org/people/PaulMorek/), licensed under CC0.\n\n- [\"Beep 04 Positive\"](https://freesound.org/people/PaulMorek/sounds/330048/) by\n [PaulMorek](https://freesound.org/people/PaulMorek/), licensed under CC0.\n\n- [\"Click 02 Double\"](https://freesound.org/people/PaulMorek/sounds/330076/) by\n [PaulMorek](https://freesound.org/people/PaulMorek/), licensed under CC0.\n\n- [\"Click 02 Single\"](https://freesound.org/people/PaulMorek/sounds/330075/) by\n [PaulMorek](https://freesound.org/people/PaulMorek/), licensed under CC0.\n\n- [\"Swish 01\"](https://freesound.org/people/PaulMorek/sounds/330066/) by\n [PaulMorek](https://freesound.org/people/PaulMorek/), licensed under CC0.\n\n- [\"e key\"](https://freesound.org/people/uEffects/sounds/180998/) by\n [uEffects](https://freesound.org/people/uEffects/), licensed under CC0.\n\n- [\"l key\"](https://freesound.org/people/uEffects/sounds/181003/) by\n [uEffects](https://freesound.org/people/uEffects/), licensed under CC0.\n\n- [\"s key\"](https://freesound.org/people/uEffects/sounds/181002/) by\n [uEffects](https://freesound.org/people/uEffects/), licensed under CC0.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Wind chime for your UNIX environment",
"version": "0.1.1",
"project_urls": {
"Download": "https://github.com/drybjed/chimed/archive/v0.1.1.tar.gz",
"Homepage": "https://github.com/drybjed/chimed"
},
"split_keywords": [
"audio",
"chime"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9dc309166532b1f355f02ee756055b1a98630236c1be6ca5e2a9712d921c944b",
"md5": "5aa048f83d61076ab8c510e480b069b7",
"sha256": "59974f6b855192acad148e55209d3b5bb147f0d7e633734b026e590085295b09"
},
"downloads": -1,
"filename": "chimed-0.1.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5aa048f83d61076ab8c510e480b069b7",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,<4,>=2.7",
"size": 487756,
"upload_time": "2024-09-19T11:21:14",
"upload_time_iso_8601": "2024-09-19T11:21:14.315328Z",
"url": "https://files.pythonhosted.org/packages/9d/c3/09166532b1f355f02ee756055b1a98630236c1be6ca5e2a9712d921c944b/chimed-0.1.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-19 11:21:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "drybjed",
"github_project": "chimed",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "chimed"
}
JSON
