script-background-music
===
[![LICENSE](https://img.shields.io/github/license/timo-reymann/python-script-background-music)](https://github.com/timo-reymann/python-script-background-music/blob/main/LICENSE)
[![CircleCI](https://circleci.com/gh/timo-reymann/python-script-background-music.svg?style=shield)](https://app.circleci.com/pipelines/github/timo-reymann/python-script-background-music)
[![PyPI version](https://badge.fury.io/py/script-background-music.svg)](https://pypi.org/project/script-background-music)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/script-background-music)](https://pypi.org/project/script-background-music)
[![pre-commit](https://img.shields.io/badge/%E2%9A%93%20%20pre--commit-enabled-success)](https://pre-commit.com/)
[![Renovate](https://img.shields.io/badge/renovate-enabled-green?logo=data:image/svg+xml;base64, )](https://renovatebot.com)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=timo-reymann_python-script-background-music&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=timo-reymann_python-script-background-music)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=timo-reymann_python-script-background-music&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=timo-reymann_python-script-background-music)

<p align="center">
    <img width="300" src="https://raw.githubusercontent.com/timo-reymann/python-script-background-music/main/.github/images/elevator.png">
    <br />
    <b>script-background-music</b> - Play elevator music in the background while your script runs.
</p>

## Features

- Play music in the background *surprised pickachu face*
- If playback fails is silently ignored


## Requirements

- [Python 3](https://www.python.org/)

## Installation

```sh
pip install script-background-music
```

## Usage

It is very simple to use the package inside your scripts ...

### ... the entire time, until your script exits

```python
from script_background_music import play_music_in_background

play_music_in_background()
```

### ... for a specific set of instructions

```python
from script_background_music import BackgroundMusicContext

with BackgroundMusicContext():
    # your instructions go here
    pass
```


### [API docs](https://timo-reymann.github.io/python-script-background-music)

## Motivation

> **Everything** is better with music!

## Documentation

### Can it break my script?

No, it should not at least. If something goes wrong playing music etc. it simply wont play music.
If you encounter the opposite feel free to create a bug report.

## Contributing

I love your input! I want to make contributing to this project as easy and transparent as possible, whether it's:

- Reporting a bug
- Discussing the current state of the configuration
- Submitting a fix
- Proposing new features
- Becoming a maintainer

To get started please read the [Contribution Guidelines](./CONTRIBUTING.md).

## Development

### Requirements

- [Python 3](https://python.org)
- [pre-commit](https://pre-commit.com/)

### Build

```
python3 setup.py sdist bdist_wheel
```

## Credits

- Special thanks to [@TaylorSMarks](https://github.com/TaylorSMarks/) for
  creating [playsound](https://github.com/TaylorSMarks/playsound) that I modified and ship with this package.
- [Clker-Free-Vector-Images](https://pixabay.com/users/clker-free-vector-images-3736/) for the
  wonderful [elevator image](https://pixabay.com/vectors/elevator-people-silhouette-down-44013/) used as project image
