Overview

<p align="justify"> Nava is a Python library that allows users to play sound in Python without any dependencies or platform restrictions. It is a cross-platform solution that runs on any operating system, including Windows, macOS, and Linux. Its lightweight and easy-to-use design makes Nava an ideal choice for developers looking to add sound functionality to their Python programs. </p> <table> <tr> <td align="center">PyPI Counter</td> <td align="center"> <a href="https://pepy.tech/projects/nava"> <img src="https://static.pepy.tech/badge/nava" alt="PyPI Downloads"> </a> </td> </tr> <tr> <td align="center">Github Stars</td> <td align="center"> <a href="https://github.com/openscilab/nava"> <img src="https://img.shields.io/github/stars/openscilab/nava.svg?style=social&label=Stars"> </a> </td> </tr> </table> <table> <tr> <td align="center">Branch</td> <td align="center">main</td> <td align="center">dev</td> </tr> <tr> <td align="center">Linux CI</td> <td align="center"><img src="https://github.com/openscilab/nava/actions/workflows/linux_test.yml/badge.svg?branch=main"></td> <td align="center"><img src="https://github.com/openscilab/nava/actions/workflows/linux_test.yml/badge.svg?branch=dev"></td> </tr> <tr> <td align="center">Windows CI</td> <td align="center"><img src="https://github.com/openscilab/nava/actions/workflows/windows_test.yml/badge.svg?branch=main"></td> <td align="center"><img src="https://github.com/openscilab/nava/actions/workflows/windows_test.yml/badge.svg?branch=dev"></td> </tr> <tr> <td align="center">macOS CI</td> <td align="center"><img src="https://github.com/openscilab/nava/actions/workflows/macOS_test.yml/badge.svg?branch=main"></td> <td align="center"><img src="https://github.com/openscilab/nava/actions/workflows/macOS_test.yml/badge.svg?branch=dev"></td> </tr> </table> <table> <tr> <td align="center">Code Quality</td> <td align="center"><a href="https://app.codacy.com/gh/openscilab/nava/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade"><img src="https://app.codacy.com/project/badge/Grade/9c384b4e400340ae94772c1d7e1842d0"></a></td> <td align="center"><a href="https://www.codefactor.io/repository/github/openscilab/nava"><img src="https://www.codefactor.io/repository/github/openscilab/nava/badge" alt="CodeFactor"></a></td> </tr> </table>

Installation

PyPI

Check Python Packaging User Guide
Run pip install nava==0.8

Source code

Download Version 0.8 or Latest Source
Run pip install .

Conda

Check Conda Managing Package
Update Conda using conda update conda
Run conda install -c openscilab nava

Usage

Basic

from nava import play
play("alarm.wav")

Async mode

⚠️ The async_mode parameter has a default value of False

import time
from nava import play, stop
sound_id = play("alarm.wav", async_mode=True)
time.sleep(4)
stop(sound_id)

Loop mode

⚠️ The loop parameter has a default value of False

⚠️ You should always set async_mode flag when you are using loop

from nava import play, stop
sound_id = play("alarm.wav", async_mode=True, loop=True)
time.sleep(100)
stop(sound_id)

Error

from nava import play, NavaBaseError

try:
    play("alarm.wav")
except NavaBaseError as e:
    print(str(e))

Engine

⚠️ The engine parameter has a default value of AUTO

from nava import play, Engine
sound_id = play("alarm.wav", engine=Engine.AFPLAY)

CLI

$ nava [--file FILE_PATH] [--loop] FILE_PATH

Engines list

List of different platforms and the corresponding engines that are used for sound playing.

<table> <tr> <th align="center">Engine</th> <th align="center">Platform</th> <th align="center">References</th> <th align="center">Supported Formats</th> </tr> <tr> <td align="center"><code>ALSA</code></td> <td align="center">Linux</td> <td align="center"><a href="https://www.alsa-project.org/wiki/Main_Page">Advanced Linux Sound Architecture</a></td> <td align="center"><code>.wav</code></td> </tr> <tr> <td align="center"><code>WINSOUND</code></td> <td align="center">Windows</td> <td align="center"><a href="https://docs.python.org/3/library/winsound.html">Winsound</a></td> <td align="center"><code>.wav</code></td> </tr> <tr> <td align="center"><code>WINMM</code></td> <td align="center">Windows</td> <td align="center"><a href="https://learn.microsoft.com/en-us/windows/win32/multimedia/mci-reference">Windows MCI (Media Control Interface)</a></td> <td align="center"><code>.wav</code>, <code>.mp3</code>, <code>.avi</code></td> </tr> <tr> <td align="center"><code>AFPLAY</code></td> <td align="center">macOS</td> <td align="center"><a href="https://ss64.com/mac/afplay.html">Audio File Play</a></td> <td align="center"><code>.wav</code>, <code>.mp3</code></td> </tr> </table>

Issues & bug reports

Just fill an issue and describe it. We'll check it ASAP! or send an email to nava@openscilab.com.

Please complete the issue template

You can also join our discord server

Acknowledgments

Python Software Foundation (PSF) grants Nava library from version 0.8 to 0.9. PSF is the organization behind Python. Their mission is to promote, protect, and advance the Python programming language and to support and facilitate the growth of a diverse and international community of Python programmers.

Show your support

Give a ⭐️ if this project helped you!

<h3>Donate to our project</h3>

If you do like our project and we hope that you do, can you please support us? Our project is not and is never going to be working for profit. We need the money just so we can continue doing what we do ;-) .

Nava

Install / Use

README