September 1, 2025
def create_greeting(name: str) -> str:
"""Create a personalized greeting message for documents."""
greeting = "Hello, " + name + "!"
message = greeting + " Welcome to Document Engineering."
return message
# call the function with different names
result = create_greeting("Alice")
print(result)Hello, Alice! Welcome to Document Engineering.create_greeting function causes each line to run sequentially"Hello, " and "!"def format_document_title(title: str, capitalized: bool) -> str:
"""Format a document title based on style preference."""
if capitalized:
formatted_title = title.upper()
result = "DOCUMENT: " + formatted_title
else:
formatted_title = title.title()
result = "Document: " + formatted_title
return result
# test both formatting styles
print(format_document_title("user guide", True) + " / "
+ format_document_title("user guide", False))DOCUMENT: USER GUIDE / Document: User Guideif statement checks the value of the formal parameterformal is True or Falsedef count_words_in_documents(documents: list) -> dict:
"""Count total words across multiple documents."""
word_counts = {}
for doc_name in documents:
word_count = len(doc_name.split()) # simple word count
word_counts[doc_name] = word_count
return word_counts
# test with sample document names
docs = ["Manual", "Installation Guide", "API Reference Document"]
counts = count_words_in_documents(docs)
print(counts){'Manual': 1, 'Installation Guide': 2, 'API Reference Document': 3}word_counts is a dictionary that starts out emptyfor loop iterates through each document name in the liststr in Pythonlist in Pythontuple in Pythondict in Pythonset in PythonLet’s explore how these work and what are their differences!
type function?full_title[9] notation?str function?+ operator?What does this illustrate about the list type in Python?
tuple is an immutable collection of ordered valuestuple?
doc_info[3] = "DOCX"doc_info.append("English")doc_info.remove("PDF")dict function make an empty dictionary document{"title": "Python Programming Guide"}str, int, and floatdocument["title"]add function places more data in a setadd with "python" do not change the set{} is an empty dictionary, not a set!
list): great for document sections that may changedict): perfect for document propertiesset): ideal for collections of unique keywordstuple): excellent for fixed document metadatastr): text content that won’t be modifieddef find_document_in_library(library: list, document_name: str) -> bool:
"""Check if a document exists in our document library."""
# assume the document is not in the library
found = False
# check if the document name is in the library
if document_name in library:
found = True
# return boolean to indicate whether document was found
return found
# test with sample document library
my_library = ["Python Guide", "Web Development", "Data Analysis"]
result = find_document_in_library(my_library, "Python Guide")
print("Found 'Python Guide':", result)Found 'Python Guide': Truefind_document_in_library work?def check_document_property(metadata: tuple, property_name: str) -> bool:
"""Check if a specific property exists in document metadata."""
# assume the property is not in the metadata
found = False
# check if the property name is in the metadata tuple
if property_name in metadata:
found = True
# return boolean to indicate whether property was found
return found
# test with sample document metadata
doc_metadata = ("User Manual", "v2.1", "English", "PDF")
result = check_document_property(doc_metadata, "PDF")
print("Contains 'PDF' format:", result)Contains 'PDF' format: Truemetadata?property_name?check_document_property?pages_per_chapter is a variabletotal_pages is a variable defined by an expression* operator multiplies two numbersprint outputs text to the console or the slidesdocument_title is a variable of type strpage_count is a variable of type intis_published is a variable of type boolprint outputs text to the console or the slideschapter_titles is a variable of type listchapter_titles is a strchapter_titles[0] accesses the first list elementprint outputs text to the console or the slidesTips for effective document engineering setup
Devote time outside class to installing and configuring tools
Confirm that most tools work during the this week’s lab session
Create and render test documents with the provided examples
Complete the first document engineering project on time
Contribute to collaborative documentation projects
Prepare for first document engineering skill check
TODO markers and blank functions for you to completeexam/ directory# navigate to your skill-check repository after cloning
cd <your-skillcheck-repository-name>
# navigate to the exam directory where all the work happens
cd exam
# verify you're in the right place for the skill-check
ls -algexam/ directoryquestions/, tests/, gatorgrade.yml, pyproject.toml, and uv.lockquestions/ directory contains files with TODO markers to completetests/ directory contains automated tests to verify your workgatorgrade.yml file configures the gatorgrade assessment tool# run gatorgrade to see what needs to be completed
uvx gatorgrade
# this will show you:
# ✅ Checks that are currently passing
# ❌ Checks that need work to pass
# 📊 Overall completion percentagegatorgrade is the automated assessment tooluv, you can type uvx gatorgradequestions/ directory (e.g., question_one.py)TODO markers that indicate where to add codeTODO markers when you complete each sectionTODO markers! You can use uvx gatorgrade to check your progress and see which functions are working! It all works in your terminal window!
# run gatorgrade after making changes
uvx gatorgrade
# you should see your completion percentage improve
# keep working until you reach 100%
# or, for specific test details, you can also run:
uv run pytest -vgatorgrade frequently to track your progress# add your completed work to Git staging area
git add .
# create a commit with a descriptive message
git commit -m "Complete skill-check programming tasks"
# push your work to GitHub
git push origin maingatorgradegit commit!TODO markers: avoid automatic failuresgatorgrade frequently: test your work as you gotests/ directoryRemember: Read carefully, code thoughtfully, test frequently, and submit regularly! If you get stuck, make sure to chat with the instructor!
Suggestions for ensuring the successful completion of a skill-check
Prosegrammers