https://github.com/Depado/parakeet

A SoundCloud player in your terminal
https://github.com/Depado/parakeet

music music-player parakeet soundcloud soundcloud-client soundcloud-player

Last synced: 28 days ago
JSON representation

A SoundCloud player in your terminal

• Host: GitHub
• URL: https://github.com/Depado/parakeet
• Owner: depado
• License: mit
• Created: 2019-07-24T16:35:30.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-08-17T19:54:15.000Z (4 months ago)
• Last Synced: 2024-08-23T14:05:19.365Z (4 months ago)
• Topics: music, music-player, parakeet, soundcloud, soundcloud-client, soundcloud-player
• Language: Go
• Size: 2.14 MB
• Stars: 22
• Watchers: 2
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Parakeet



  


  [![forthebadge](https://forthebadge.com/images/badges/made-with-go.svg)](https://forthebadge.com)[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)[![forthebadge](https://forthebadge.com/images/badges/uses-badges.svg)](https://forthebadge.com)

  ![Go Version](https://img.shields.io/badge/Go%20Version-latest-brightgreen.svg)

  [![Go Report Card](https://goreportcard.com/badge/github.com/Depado/parakeet)](https://goreportcard.com/report/github.com/Depado/parakeet)

  [![Build Status](https://drone.depa.do/api/badges/Depado/parakeet/status.svg)](https://drone.depa.do/Depado/parakeet)

  [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Depado/parakeet/blob/master/LICENSE)

  [![Say Thanks!](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/Depado)

  SoundCloud player in your terminal



Note: This is a work in progress. Documentation should be updated soon.

The code is currently in a **very** dirty state.

![screenshot](img/screenshot.png)

## Limitations

Currently, parakeet has some limitations:

- It will play only the last 50 favorites tracks from the user ID you provide

- It can't read Go+ sounds even if the client ID comes from a Go+ account

- Some tracks can't be fetched properly and will be skipped automatically

## Install

From source:

```sh

$ go get github.com/Depado/parakeet

$ cd $GOPATH/src/github.com/Depado/parakeet

$ make install

```

Alternatively you can download the binary release of parakeet on the 

[releases page](https://github.com/Depado/parakeet/releases).

This project uses [beep](https://github.com/faiface/beep) which in turn uses 

[oto](https://github.com/hajimehoshi/oto) so make sure to check the 

[requirements](https://github.com/hajimehoshi/oto#prerequisite) before trying to 

run parakeet.

## Configure

For now this project needs both a SoundCloud client ID and a user ID. It will

fetch the first 50 favorite tracks of the user and will play them one after

another just like SoundCloud would in your browser or app.

### Environment Variables

Setup the following environment variables:

- `PARAKEET_CLIENT_ID`: Your SoundCloud client ID

- `PARAKEET_USER_ID`: Your SoundCloud user ID

### Flags

You can also pass these settings using flags when running parakeet:

```sh

$ parakeet --client_id  --user_id 

```

## TODO

- [ ] Display more metadata in the information panel

- [ ] Allow to pass directly an URL to a playlist or user to stream music from

- [ ] Implement pagination

- [ ] Refactor player logic

- [ ] Handle clicks (move cursor in track, play/pause, etc)