Skip to main content

Wind chime for your UNIX environment

Project description

# chimed - wind chines 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/):

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

chimed-0.1.0-py2.py3-none-any.whl (487.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file chimed-0.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: chimed-0.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 487.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for chimed-0.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 936c81e900e3f6e3b5f95235371a5b28783ef42227015a73af80ff85e8e9bf58
MD5 c261d2de28271e6f9e58844a38981809
BLAKE2b-256 da1aa785572e2235facf7b41e52f0fe5c9f35c79801e268faae952235fa66ac3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page