Skip to main content

Simple noiser: Run to annoy the user.

Project description

spnoiser

Simple noiser: a tiny terminal alarm that repeats a message on the screen and can loop a short audio file (WAV recommended).

The package entry point is spnoiser.app. The main function accepts command-line arguments to control the displayed text, maximum duration, and an optional audio file to loop. If no audio file is provided, the program will attempt to use the terminal beep.

This project uses src/main.py as an alternative entrance, for debugging especially.

Quick start

  • Run directly from source:
uv run src/main.py -n "Beep" -t 120
  • Install editable and run:
uv tool install -e .
spnoiser -n "Beep" -t 120

Note: the spnoiser console script is provided by the package entry point and is available after installation.

Command-line arguments

The program (via spnoiser.app:main) supports the following options:

  • -n, --noise : Text to repeat on the terminal.
  • -t, --time : Maximum annoying time in seconds.
  • -s, --sound : Path to an audio file to loop. If omitted, the terminal beep is used when available.
  • -v, --volume : Volume level for the sound file (>= 0.0). Default is 1.0.

Examples:

# Install first
uv tool install -e .

# Custom text and infinite duration, use terminal beep
spnoiser -n "Beep!" -t 0

# Loop a sound file to play instead of terminal beep
spnoiser -s "music/alarm.mp3"

License

This project is licensed under the Apache License 2.0.

See the LICENSE file or the Apache website for the full license text: http://www.apache.org/licenses/LICENSE-2.0

Project details


Download files

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

Source Distribution

spnoiser-1.1.2.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spnoiser-1.1.2-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

Details for the file spnoiser-1.1.2.tar.gz.

File metadata

  • Download URL: spnoiser-1.1.2.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.6

File hashes

Hashes for spnoiser-1.1.2.tar.gz
Algorithm Hash digest
SHA256 0ccf91fcec5c450cbcf7b5a95108cb3f7b3a1c4dcce2a817ee6b91826463059e
MD5 6b4e6e01a3d966aeafaa06920680a851
BLAKE2b-256 47800d07aaeb5b99e4f3e0f9dc67ccf23846a15bef5b84ea5a8fbae204cb9b71

See more details on using hashes here.

File details

Details for the file spnoiser-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: spnoiser-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 16.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.6

File hashes

Hashes for spnoiser-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ef052d1a05fb45f1586d478e971e0b71199810279ca04cd134b3f8059a1ec2e0
MD5 caeeda1ac57bcb61cce709ba2e4d115d
BLAKE2b-256 9253dc0e8a77a23db14e438111bf45cee812b2359e92097dd9334bd2f29b0e9f

See more details on using hashes here.

Supported by

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