snakejazz 0.1.1

SnakeJazz

Decorators for sound reproduction
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Standard Installation
   • Development Install
3. Basic Usage
4. Sounds
5. Contributing
6. License
7. Author
8. Acknowledgements

About The Project

SnakeJazz provides decorators to let you listen to the running status of your Snake Python functions. Most definitly inspired by Rick and Morty :wink:

These are the decorators:

• snakejazz.zzz: You can choose to reproduce a sound at the moment your function starts to excecute, when it finishes or when an error occurs. A different sound for each event can be given.

• snakejazz.www: Exactly the same as zzz, but you can specify youtube links and the audio will be downloaded.

• snakejazz.rattle: Rattle from start to finish. This will loop the sound until your function ends. You can either give a local path or a youtube link.

All three of them can be used directly to run with the default configuration. But you can also give some custom sounds for a more enjoyable moment.

Getting Started

There are two simple steps to have SnakeJazz running on you python scripts.

Prerequisites

SnakeJazz works with ffmpeg library for audio processing. To install it simply run:

• apt

  sudo apt update
  sudo apt install ffmpeg
  

• dnf

  sudo dnf install ffmpeg
  

You will also need a nice set of headphones to run SnakeJazz. :headphones:

Installation

1. Standard Installation

   pip install snakejazz
   

2. Development Install

   git clone https://github.com/mchalela/SnakeJazz.git
   cd SnakeJazz
   pip install -e .
   

Basic Usage

Let's say you have a function that takes some time to compute. Just plug-in the decorator of your preference and you're good to go!

import time
import snakejazz

@snakejazz.rattle
def wait(t):
    """Some function to simulate computing time."""
    time.sleep(t)
    return

# Put on your headphones and run it!
wait(22)

The rattle decorator will play a sound in loop until your function ends.

Now let's say you want to be notified if an error occurs during the execution of your function.

import time
import snakejazz

@snakejazz.zzz(when_error=True)
def wait(t):
    """Some function to simulate computing time."""
    time.sleep(t)
    raise ValueError('Something went wrong')
    return

# Put on your headphones and run it!
wait(3)

Sounds

For the moment SnakeJazz comes with one pack of 33 free sounds called Rhodesmas (available here: link). You can listen to them with the function snakejazz.play_sound. Just run this code:

import snakejazz

for sound, path in snakejazz.sounds.RHODESMAS.items():
    print(f'Playing {sound}')
    snakejazz.play_sound(path)

Contributing

This is an open source project made to be shared. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Author

Martin Chalela - email: tinchochalela@gmail.com

Project Link: https://github.com/mchalela/SnakeJazz

Acknowledgements

• Rhodesmas sounds created by rhodesmas from Freesound.
• Snake and Saxophone icons: Icons made by Freepik from www.flaticon.com.