parakeet

command module
v0.0.0-...-5bcf8f0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 3, 2024 License: MIT Imports: 11 Imported by: 0

README

Parakeet

mascot

forthebadgeforthebadgeforthebadge

Go Version Go Report Card Build Status License Say Thanks!

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

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:

$ 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.

This project uses beep which in turn uses oto so make sure to check the requirements 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:

$ parakeet --client_id <yourclientID> --user_id <youruserID>

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)

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL