August 25, 2025
from typing import Dict
import string
def word_frequency(text: str) -> Dict[str, int]:
"""Analyze text and return a dictionary of word frequencies."""
cleaned_text = text.lower().translate(str.maketrans('', '', string.punctuation))
words = cleaned_text.split()
frequency_dict = {}
for word in words:
frequency_dict[word] = frequency_dict.get(word, 0) + 1
return frequency_dict# example text about document engineering
sample_text = "Document engineering combines programming with writing. Writing clear documents requires skill."
# analyze the text and display results
word_counts = word_frequency(sample_text)
print("Word Frequencies:")
for word, count in sorted(word_counts.items()):
print(f"'{word}': {count}")Word Frequencies:
'clear': 1
'combines': 1
'document': 1
'documents': 1
'engineering': 1
'programming': 1
'requires': 1
'skill': 1
'with': 1
'writing': 2word_frequency function!import re
from typing import Dict, Any
def document_summary(text: str) -> Dict[str, Any]:
"""Generate a comprehensive summary of document statistics."""
# count words (excluding punctuation-only tokens)
words = [word for word in text.split() if any(char.isalnum() for char in word)]
word_count = len(words)
# count sentences (simple approach using sentence-ending punctuation)
sentences = re.split(r'[.!?]+', text)
sentence_count = len([s for s in sentences if s.strip()])
# count paragraphs (assuming double newlines separate paragraphs)
paragraphs = [p for p in text.split('\n\n') if p.strip()]
paragraph_count = len(paragraphs)
# calculate averages
avg_words_per_sentence = word_count / sentence_count if sentence_count > 0 else 0
avg_sentences_per_paragraph = sentence_count / paragraph_count if paragraph_count > 0 else 0
return {
'word_count': word_count, 'sentence_count': sentence_count,
'paragraph_count': paragraph_count,
'average_words_per_sentence': round(avg_words_per_sentence, 1),
'average_sentences_per_paragraph': round(avg_sentences_per_paragraph, 1)
}document_summarydocument_summary: analyzes text structure and readabilityre for sentence detection and provides key quality metrics# define an example document about prosegrammers
sample_document = """
Prosegrammers are skilled professionals who combine programming expertise with writing abilities. They create tools that help generate, analyze, and improve documents.
Document engineering is an exciting field that leverages technology to enhance written communication. Python provides excellent libraries for text processing.
By mastering both code and prose, prosegrammers can automate repetitive writing tasks, analyze large collections of documents, and create dynamic content.
"""
# analyze the document using the defined summary function
summary = document_summary(sample_document.strip())
print("Document Analysis Summary:")
for metric, value in summary.items():
print(f"{metric.replace('_', ' ').title()}: {value}")Document Analysis Summary:
Word Count: 62
Sentence Count: 5
Paragraph Count: 3
Average Words Per Sentence: 12.4
Average Sentences Per Paragraph: 1.7document_summary in your teams:
document_summary in your teams:
Tips for effective document engineering setup
# Run these commands in your terminal window
git --version # Check Git installation
python --version # Check Python (via UV)
quarto --version # Check Quarto installation
code --version # Check VS Code installation
uv --version # Check UV package managerquarto preview? What output do you see?ssh keys for GitHub to ensure secure communicationgit clone git@github.com:prosegrammers/www.prosegrammers.com.gitcd www.prosegrammers.com to change into this directoryquarto preview to build and serve the website locallyuv! How fun!www.prosegrammers.com directorycd scripts to change to the scripts/ directoryuv run welcome.py to receive your welcome to the course!Tips for effective document engineering setup
Devote time outside class to installing and configuring tools
Confirm that most tools work during the first lab session
Successfully get all tools to work during the first 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
Prosegrammers