Make the tool usable

Make the useful result easy to obtain

A report is more useful when another person can generate it from the instructions, recognize its output and recover from a common problem.

Click Open formatted report to see the result the local instructions lead toward.

This lesson uses the supplied current reporting program. You will download it, find the correct folder, generate HTML and check the result. The Python program needs no model call.

Delivery means a usable local package and instructions. Publication, deployment and sharing another person's activity data are separate tasks.

Read the course setup instructions. Use synthetic data throughout.

Find the folder the commands need

The command is short. Selecting the correct extracted folder is the prerequisite that makes it work.

1. Click Download checked example ZIP.
2. Extract the ZIP to a new practice folder. Keep any previous extraction and reports intact.
3. Find the extracted folder containing report.py and data/activity.csv. The ZIP stores those paths at its root; your extraction tool may wrap them in another folder.
4. Ask your assistant for the exact cd command to enter that folder. On Mac, you can type cd followed by a space in Terminal, drag that folder from Finder into Terminal and press Return.

Use an existing Python 3.12 environment as described in Runnable reference instructions. The optional test command additionally needs pytest.

Folder check: can you locate the script and the CSV named by the next command? If either is absent, correct the folder before running it.

Create a report you can open

From the extracted example folder, run the program on the supplied synthetic CSV and choose a new output filename.

Read the command before running it. It reads data/activity.csv and creates activity-report.html in the current folder. It does not call a model.

Expected result: Saved report to activity-report.html. Ask your assistant to open that file in your browser, or open it yourself.

If the destination already exists, the program refuses it with Output error: the output path already exists; choose a new path. Keep the existing file and choose an unused name, such as activity-report-second.html, in the --output argument. Open the same filename you selected.

Invalid input is reported before a report is written. If the command reports an input or output error, retain the message and inspect the named path before trying again.

HTML report command

python3.12 report.py data/activity.csv --format html --output activity-report.html

Connect the report to its source

A successful file write tells you a file was created. Check that it contains the result you intended.

1. Confirm the report covers 19–21 October 2026, with 6 entries and 270 minutes or 4 hours 30 minutes.
2. Compare the project totals: Orion 180 and Lumen 90.
3. Compare the category totals: Development 150, Documentation 75 and Testing 45.
4. Read one row in data/activity.csv and explain where it contributes to the totals.

The report is a standalone HTML file with a print layout. Use your browser's print command if you want a paper or PDF copy, then inspect the preview before saving or printing.

baseline text command

python3.12 report.py data/activity.csv

Change a copy and predict the result

Practice changing input without losing the original six-row fixture or a previous report.

1. Copy data/activity.csv to a new file named data/activity-practice.csv.
2. In that copy only, change Lumen's Documentation entry from 30 to 45 minutes. Keep the original fixture unchanged.
3. Predict the effect before running: 6 entries and 285 minutes; Orion 180; Lumen 105; Development 150; Documentation 90; Testing 45.
4. Choose an unused output filename and run the practice command. Compare its actual result with your prediction.

Read the command before running it. It selects the practice copy and a different output path.

The expected totals above are calculated from the proposed input change. They are not a recorded execution result. If your output differs, inspect the edited row and command rather than changing the expected answer to match.

practice report command

python3.12 report.py data/activity-practice.csv --format html --output activity-practice.html

Give the next person one clear route

Write instructions around the actual folder, command, expected result and common refusal.

Your handoff note

Write your answer in your own notes, or use the interactive lesson.

This optional note stays in local browser storage when available. It does not publish or send the handoff.

Know what is ready and what still needs checking

You can now explain how to obtain the report and how to preserve a previous result.

Explain the handoff in your own words: where to start, which file is produced, how to check one number and what happens when the destination already exists.

A local file that you can open is useful progress. Another person's successful walkthrough, their help needed and any platform or printer observations are additional evidence to collect rather than assume.

Next: Open Tutorial 6: Make it work for your needs to prepare one bounded change.