Metadata-Version: 2.4
Name: beepper
Version: 1.1.0
Summary: Makes an alert noise
Author-email: Henrik Koski <henrikkoski00@gmail.com>
License: Copyright © 2025 PiispaH
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: simpleaudio
Requires-Dist: numpy
Dynamic: license-file

# Beepper

[![PyPI downloads](https://img.shields.io/pypi/dm/beepper.svg)](https://pypi.org/project/beepper/)

Simple interface to create an alert noise. Might cause a [silent crash](https://github.com/hamiltron/py-simple-audio/issues/72) after the sound has stopped playing when using python 3.12.

### Usage

Has a single parameter for setting the volume.

Example usage in a project:

    from beepper import beep

    for i in seq:
        do_something(i)

    beep(1.5)

    do_something_else()

In the example, beep gets called after the loop. The function `do_something_else` gets called while the beep is still running in the backround.

The sound can also be played in a blocking manner. By calling the function with an additional argument `beep(1.5, True)`, the program waits until the sound has stopped playing until the next line gets executed.
