OgJAkFy8 / Mad-Libs

A Python program that is based on the old paper Mad-Libs

Welcome to Mad-Libs in Python

This was a project that I started with my nephews a number of years ago to teach them how to program in Python, because they were all using Minecraft. I also wanted to relearn Python (Orignially learned with version 2.3 or something.), specifically version 3.x. This current version has been written using Python 3.9 on a windows 10 machine.

How to get it

• Main page link
• Download the current version from HERE

How to use it

1. Open or run the start_MadLibs.py file.
2. Answer the questions.
3. Read the output file.

Root Folder

./Mad-Libs -

Root Folder Structure

• ./Blank-Letters - The program started from the idea of someone writing home from summer camp. The "Letters" are the templates that need will be modified by the program when run.
• ./Examples - A place for the earlier programs that still work.
• ./Sketchpad - For notes, temp work and other items, that are not required for the program to run.
• ./Sketchpad/Incomplete - This is where the older programs went to die.
• ./modules - The current program was built using modules. This mostly due to the way I was building it. I started using other parts of the older programs and put them into functions (def) which are called through the main program 'start_MadLibs.py' .
• ./Outputs - This folder holds the completed "Letters". It is also in the .gitignore file, so that it is not replicated.

Root Files

• ./.gitignore - Prevents the Output files from being replicated.
• ./README.md - This file.
• ./start_MadLibs.py - The main "Mad-Libs" program.

Program Files

• ./start_MadLibs.py - Starts the program.

  • Calls the following modules:
    • import modules.fileModule as fm
    • import modules.madregexModule as ml
    • import tkinter as tk
    • from tkinter import messagebox

• ./modules/fileModule.py

  • The file module contains:
    • Select_Letter
    • Assemble_Letter
    • Write_Letter

• ./modules/madregexModule.py

  • The Mad RegEx Module contains:
    • modifyList - This was used during testing so that I could pull in a bunch of strings. The function was later split with the "String" one which is what is passed to it by the "Assemble_Letter" script.
    • modifyString - This is where the "Magic" happens. It simply uses a RegEx (Regular Expression) to look for the key words in the Blank-Letter files.

    import re
    MadEx = re.compile(r"(?i)(?:Lib)\_{1,3}(verb|person|people|place|thing|job|noun(s)*|adj([ective])*)")
    inputItem = MadEx.search(MadString).group(1)
    MadEx.sub(InPut,MadString,1)
    

    • Above are the lines of code that does the work. As of this writing, it looks for verb, person, people place, thing, noun and adjective

Input and Output

The input is build by you the programmer, the output is build by the user.

Input

The input files are just txt files that have been modified to have some words replaced by the keywords.

• **./Blank-Letters/ShortLetter.txt - primarily used for testing, because it only calls a couple blanks.
• **./Blank-Letters/campletter.txt - The full version of letter template.

Keywords - Keywords are the words that are seached for during program execution.

Lib_verb        # Action word: Jump, bet
Lib_person      # Proper name: Johnny, Stevie, Roland
Lib_people      # Multiple people: Foosball Team, passengers
Lib_job         # Cook, umpire
Lib_place       # Place: bus stop, LA
Lib_thing       # Thing: moon
Lib_noun(s)     # A person, place or thing - This may make way for the above
Lib_adj(ective) # A word that discribs a noun: _blue_ car

Building the Template files

1. On the first line of the document, type the title of the paragraph/letter. See FUTURE FEATURES below. EXAMPLE Title:Summer Camp Diary
2. Find a sentence or paragraph that you like.
3. Starting on the second line paste it into a txt file.
4. Replace the different words with the above keywords. EXAMPLE The fast brown dog. would become:

• The fast Lib_adj Lib_thing.
• The Lib_adverb brown Lib_noun.

Output

• ./Outputs/Letter-Home_235036.txt - An example of what one of the outlook files will be named.

Future Features

1. The user will be able to see the TYPE of document they are working on. To help tailor their responses. In otherwords, when you run the program you will have a base idea of what you are working on.
2. Currently the user selects the Letter they want to work on. This might be made random.