A Ruby Gem to convert SongPro songs to a Ruby object used to generate various output formats.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


SongPro Build Status

SongPro is a text format for transcribing songs.

This project is a Ruby Gem that converts the song into a data model that can then be converted into various output formats such as text or HTML.

It is heavily inspired by ChordPro.


Add this line to your application's Gemfile:

gem 'song_pro'

And then execute:

$ bundle

Or install it yourself as:

$ gem install song_pro


Given then file bad-moon-rising.sng with the following contents:

@title=Bad Moon Rising
@artist=Cleedence Clearwater Revival

# Intro


# Verse 1

[D]I see a [A]bad [G]moon a-[D]rising
[D]I see [A]trouble [G]on the [D]way
[D]I see [A]earth-[G]quakes and [D]lightnin'
[D]I see [A]bad [G]times to-[D]day

You can then parse the file to create a Song object:

require 'song_pro'

text = File.read('bad-moon-rising.sng')
song = SongPro.parse(text)

puts song.title
# Bad Moon Rising

puts song.artist
# Creedence Clearwater Revival 

puts song.sections[1].title
# Verse 1

SongPro Format

  • Attributes are declared using: @key=value
  • Sections are declared using: # Section Name
  • Chords are declared using: [Xy#]
@title=Bad Moon Rising
@artist=Cleedence Clearwater Revival

# Intro


# Verse 1

[D]I see a [A]bad [G]moon a-[D]rising
[D]I see [A]trouble [G]on the [D]way
[D]I see [A]earth-[G]quakes and [D]lightnin'
[D]I see [A]bad [G]times to-[D]day

Song Object

  • a Song can have a Title
  • a Song can have an Artist
  • a Song has zero or more Sections
  • a Section has zero or more Lines
  • a Line has one or more Parts
  • a Part has a Chord and Lyric
  • a Chord is the textual representation of a single chord
    • this may be empty
  • a Lyric is the textual representation of lyrics
    • this may be empty


After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.


Bug reports and pull requests are welcome on GitHub at https://github.com/spilth/song_pro.


The gem is available as open source under the terms of the MIT License.