samm82 / worshiplist

A program that will generate a chord sheet for a certain list of songs specified.

About Me

Hello! My name is Samuel Crawford; I have a B.Eng. in Software Engineering from McMaster University, and I am back at McMaster for my M.A.Sc., working on Drasil. I am the recipient of a Schulich Leader Scholarship for community leadership and academic excellence, and I strive to put my skills to good use wherever I find myself.

Skills

• My areas of expertise are object-oriented design, functional programming, and software testing
• My main languages are Python, Haskell, LaTeX, Dart, and Java
• I am comfortable with common tools and frameworks like Git, Flutter, pytest, and Make
• I have experience with MATLAB, Bash, C, C++, and SQL

worshiplist's Issues

Setting for allowing duplicate songs

Add an option to settings to allow for a song to be added multiple times (e.g. in different keys)

Reduce duplication in song files

I shouldn't have to store the song files in two directories; there should be a debug mode and a build mode that selects the path to the song files

Print out Status Updates

eg. "Outputted Doc", "Converted to PDF", "Done"

Add Page Breaks

If a song gets split over two pages, add a page break before it.

Add support for accidentals

e.g., ending verse of "O Come to the Altar', Bridge 3 of "Ancient Gates"

Refactor if-elif-else tree in writeLine

Use match case?

Create Helper function to create a list of Buttons (Close and not close?)

When exiting GUI, command prompt should be empty

Exiting out of the GUI causes errors in the command line, due to variables not being passed (ie. an empty list can't be indexed)

Add support for suspended chords

e.g., intro of Everything that Has Breath (Praise)

Ensure song files can handle keys with lots of sharps/flats

e.g., Holy Spirit (A), To the One (F#), Goodness of God (B)

New Page Spacing Issue

Cases to Test

• The Goodness of Jesus, A Thousand Hallelujahs, Jesus We Love You, (space issue is here), Living Hope, and Holy Ground
• Shout Hosanna, To the One, (space issue is here)
• Who You Say I Am, Way Maker, Build My Life, (space issue is here) Holy Spirit

Split into Modules

Split WorshipList.py into:

• Main.py
• Document.py
• Exceptions.py
• GUI.py
• MusicData.py

Fix what happens when longer than one line

Process Multiline Titles Better

e.g., Did You Feel the Mountains Tremble?

Create Song Files

TODO

• Breakthrough
• Do It Again
• Forever
• Glory
• Here I Bow
• I Speak Jesus
• I Surrender
• It Is Well - Bethel
• Look to the Son
• Love on the Line
• My King Forever
• Oceans
• You Make Me Brave

Improve implementation of "repeats"

Why use "double" when "x2" works just as well? Make this general - no extra code should have to be written to allow for "x4" (when this is ready, the verse of King of Kings should be x4)

Split songGUI into songGUI and fileNameGUI

So that the songs and keys don't have to be entered for every invalid file name

Status outputs to command line should really be output as a GUI

Since the application will be run without the terminal, the system status should be output as a GUI to be viewed by the user

Filter Illegal Characters from Song Filenames but Not Song Titles

Came about with "Did You Feel The Mountains Tremble?"

TODO

• Check that there is at least one legal character to be used as the song title
• Change the list of songs in the dropdown to get the first line of each file, instead of the file name

Compile into .exe

• Use pyinstaller to compile into one .exe file
  • Uncomment -w to enable windowed mode once it isn't broken (see this StackOverflow post)
• Prompt user the option to create/download Settings.txt and songs/ or have them automatically generated if not found in current directory?
  • What to do when songfiles exist? Overwrite?
• Create README.md with information about running the program and setting up the environment
  • Auto-generate/copy from stable and put command to do so in Makefile?
• Add icon?

Make Name of File in same GUI as song selector

Slightly Increase Space between Songs

Implement Exceptions

• Invalid key
• Invalid chord
• Invalid entry in text file

Remove use of `pathlib`

Trying to make compile results in the following error:

$ make compile
pyinstaller --onefile src/Main.py -n WorshipList -i src/icon.ico -w
The 'pathlib' package is an obsolete backport of a standard library package and is incompatible with PyInstaller. Please remove this package (located in C:\Users\samcr\AppData\Local\Programs\Python\Python312\Lib\site-packages) using
    "C:\Users\samcr\AppData\Local\Programs\Python\Python312\python.exe" -m pip uninstall pathlib
then try again.
make: *** [compile] Error 1

pathlib should be replace with a more standard library

Reduce spacing between Lines

Current output should fit on one page

PyInstaller no longer recognizing win32com (from the pywin32 or pypiwin32 packages)

This may have been because of using python instead of py; cbdd7b8 may have fixed this, but this should be verified after #58

Improve Documentation

TODO

• Update README
  • Find better format for Contents
• Add doxygen comments
• Add doxygen capabilities
• Better comments throughout code
• Pull out key duties to getNotes()
• Add README to src/ folder

Use title case for song titles

https://pypi.org/project/titlecase/ - this ignores words like "and"
use the title method for file names

Add automated testing

Check out PyAutoGUI

Add Warning when Generating a Chart from an Empty Song File

User should be able to Go Back, Refresh (ie. after populating file), or Generate Anyways

Add Capability for Small Text

FIXED: Linked with parentheses

Allow for small text to conserve space

Keep input in case of error so user doesn't have to start over

Work is mostly done in keepInput - after some final testing, it can be merged and this issue closed

• Implement a way to keep all input, not just correct input
• Warn if kept input would be removed with a reduction of the number of songs in GUI
• Don't use closebuttons for getting input in case of invalid input that would need to be changed

Add better method of indicating a chord should be held than duplicating the chord

e.g., Shout Hosanna

Implement Interactive Input

Use PySimpleGUI (?)

Lint code

Make "Use Next Sunday" populate file name field instead of auto-submitting it

`filename` in `writeSong` in Document.py is not formatted to match filenames in songs/

This is because filename is taken from the songList.txt without being formatted to work with the files; the fix is to use the same method of filename verifying used when creating a new song file.

Is `tab_stop` in Document.py necessary?

Nope! Removed

Allow for Multiple Entries on One Line

• Make function for writing line
• Iterate through lines by number, not by line
• Call writeLine recursively with 'same' keyword

For space consolidation, allow for multiple entries in the same line. See example:

^ This example probably won't work anymore - try with Glorious Day though

Working on branches SameLine and SameLine2 - very hard

Allow for Searching in Song DropDowns

See this Reddit post and this StackOverflow post for guidance

Also implement a way to find close matches (e.g. "Anonting" -> "Anointing")

Refactor `small` into an enum type

Add Filename Checking for Adding Songs

Add support for file paths for different systems

• Use Python library for dealing with file paths
• Change Settings.txt to use new file path method
• Add functionality to change output path from GUI
• Pull out file path for src/ to maybe be variable in future alongside #26
  • Settings file -> "src: srcPath \n output: outputPath"
  • Instantiate Settings upon first run of WorshipList.exe
    • Check if src/output directories can be found before asking for user input

Automate List of Songs for Drop-Down Menu

Allow user to add more lines to a song file

Similar to how they can when selecting songs

Refactor writeSection

Should iterate until a colon is found, and throw an error if missing from songfile

Fix Line Breaking

In the file "LIFT Worship 1-12-20", the song "What a Beautiful Name" was pushed onto a separate page when there was room for it on just one page.

• Fix erroneous splitting
• Add option to reduce font size of titles to accommodate one page (hard)

Ensure GitHub action to build works

• Add "Last Compiled" line to README and update with current date
• "WorshipList" file ends up in zip built on GitHub? Fix: removed in GitHub action

Implement Method for Adding Songs

The song adding process should be more straight forward and not involve adding a .txt file.

• Create a blank file with the song name
• Add key names for each field for easy referencing
• Add functionality for "same"
• Check that each chord (or similar: "x2", etc.) is valid
• Add commonly used section names
• Test by adding songs

Don't require a space after "/" in song files

Song file input should automatically be split on "/" for ease of reading/adding the song files