cclifile¶

class openlp.plugins.songs.lib.importers.cclifile.CCLIFileImport(manager, **kwargs)[source]¶

Bases: openlp.plugins.songs.lib.importers.songimport.SongImport

The CCLIFileImport class provides OpenLP with the ability to import CCLI SongSelect song files in TEXT and USR formats. See http://www.ccli.com/ for more details.

NOTE: Sometime before 2015, CCLI/SongSelect has changed the USR filename to a .bin extension; however,: the file format remained the same as the .usr file format.

do_import()[source]¶: Import either a USR or TEXT SongSelect file.

do_import_txt_file(text_list)[source]¶

The doImport_txt_file() method provides OpenLP with the ability to import CCLI SongSelect songs in TXT file format.

Parameters:	text_list – An array of strings containing the txt file content.

SongSelect .txt file format:

Song Title                  # Contains the song title
<Empty line>
Verse type and number       # e.g. Verse 1, Chorus 1
Verse lyrics
<Empty line>
<Empty line>
Verse type and number (repeats)
Verse lyrics
<Empty line>
<Empty line>
Song CCLI number
    # e.g. CCLI Number (e.g.CCLI-Liednummer: 2672885)
Song copyright (if it begins ©, otherwise after authors)
    # e.g. © 1999 Integrity's Hosanna! Music | LenSongs Publishing
Song authors                # e.g. Lenny LeBlanc | Paul Baloche
Licencing info
    # e.g. For use solely with the SongSelect Terms of Use.
All rights Reserved.  www.ccli.com
CCLI Licence number of user
    # e.g. CCLI-Liedlizenznummer: 14 / CCLI License No. 14

do_import_usr_file(text_list)[source]¶

The doImport_usr_file() method provides OpenLP with the ability to import CCLI SongSelect songs in USR file format.

SongSelect USR file format

[File]: USR file format first line
Type=: Indicates the file type e.g. Type=SongSelect Import File
Version=3.0: File format version
[S A2672885]: Contains the CCLI Song number e.g. 2672885
Title=: Contains the song title (e.g. Title=Above All)
Author=: Contains a | delimited list of the song authors e.g. Author=LeBlanc, Lenny | Baloche, Paul
Copyright=: Contains a | delimited list of the song copyrights e.g. Copyright=1999 Integrity’s Hosanna! Music | LenSongs Publishing (Verwaltet von Gerth Medien Musikverlag)
Admin=: Contains the song administrator e.g. Admin=Gerth Medien Musikverlag
Themes=: Contains a /t delimited list of the song themes e.g. Themes=Cross/tKingship/tMajesty/tRedeemer
Keys=: Contains the keys in which the music is played?? e.g. Keys=A
Fields=: Contains a list of the songs fields in order /t delimited e.g. Fields=Vers 1/tVers 2/tChorus 1/tAndere 1
Words=: Contains the songs various lyrics in order as shown by the Fields description e.g. Words=Above all powers…. [/n = CR, /n/t = CRLF]

Parameters:	text_list – An array of strings containing the usr file content.