An open API service indexing awesome lists of open source software.

https://github.com/woodruffw/shaq

A CLI client for Shazam
https://github.com/woodruffw/shaq

Last synced: 6 months ago
JSON representation

A CLI client for Shazam

Awesome Lists containing this project

README

          

# shaq

[![CI](https://github.com/woodruffw/shaq/actions/workflows/ci.yml/badge.svg)](https://github.com/woodruffw/shaq/actions/workflows/ci.yml)
[![PyPI version](https://badge.fury.io/py/shaq.svg)](https://badge.fury.io/py/shaq)

A bare-bones CLI client for [Shazam](https://www.shazam.com/home).

![shaq in action](https://github.com/woodruffw/shaq/assets/3059210/3ee02414-b1c0-4379-8c9d-cb646dba9902)

## Installation

`shaq` is available via `pip` or `pipx`:

```bash
pip install shaq
pipx install shaq
```

If you run into installation errors, make sure that you have PortAudio
installed. On Debian-based systems:

```bash
sudo apt install -y portaudio19-dev
```

`shaq` is also available on the Arch User Repository as [`shaq`](https://aur.archlinux.org/packages/shaq).

## Usage

Detect by listening to the system microphone:

```bash
# shaq listens for 10 seconds by default
shaq --listen

# tell shaq to listen for 15 seconds instead
shaq --listen --duration 15
```

Detect from an audio file on disk:

```bash
# shaq truncates the input to 10 seconds
shaq --input obscure.mp3

# ...which can be overriden
shaq --input obscure.mp3 --duration 15
```

See `shaq --help` for more options.

## The name?

[Shazam](https://www.shazam.com/home),
[Shazaam](https://en.wikipedia.org/wiki/Kazaam#%22Shazaam%22),
[Kazaam](https://en.wikipedia.org/wiki/Kazaam),
[Shaquille O'Neal](https://en.wikipedia.org/wiki/Shaquille_O%27Neal).