Is your course folder finished? A free script that checks.

A script that tells you whether your course folder is finished

If you are building a course as a folder of notes - in Obsidian or anywhere else - there are four things wrong with it right now that you cannot see, because all four are invisible on the machine that made them.

A link pointing at a note you never wrote. Obsidian colours unresolved links slightly differently. You stop noticing that by the third evening.

A note nothing links to. It might be your best one. Nobody will ever open it.

A lesson that ends without anything to do. That is a blog post with a price on it, and it is the single most common reason a course reads as thin.

An export made before your last three edits. The most common of the four by a distance, and the buyer is the one who finds out.

The script below reads your folder and prints one line per problem. It changes nothing, ever. Standard library only, Python 3.8 or newer, nothing to install.

Run it

Put check-vault.py in your course folder and run:

python3 check-vault.py

That checks the folder the script is sitting in. To check a folder somewhere else, or to check an exported zip at the same time:

python3 check-vault.py /path/to/your-vault
python3 check-vault.py /path/to/your-vault /path/to/your-course-v1.zip

It prints a count of problems, and no congratulations when the count is zero.

The four rules it assumes about your folder

The script expects the shape below, because these four rules are what keep a folder working once there are sixty notes in it. If yours is different, the constants at the top of the script are meant to be changed.

my-course/
  Start Here.md
  Module 1 - <your title>.md
  Lessons/
  Templates/
  Prompts/
  Examples/
  Tools/

Folders are for kinds of thing, not for topics. Lessons/ and Templates/ are kinds. Advanced/ and Week 2/ are topics, and topics move. Every reorganisation by topic breaks paths, and a buyer who unzips it gets a note pointing at a folder that no longer exists.

Numbers in lesson filenames, words everywhere else. 01 - , 02 - gives you a reading order in the file list without a plugin. Templates and prompts have no order, so they get names you can guess.

The filename is the title. No front matter to maintain. Links point at filenames, so a note named for what it is makes every link readable, and a link that reads like a sentence is a link people follow.

No plugins. Not because plugins are bad, but because your buyer does not have yours. Anything built on a community plugin renders as broken syntax on their screen.

What it cannot do

It cannot tell you whether a lesson is worth reading, and it cannot open your zip on somebody else's computer. Both of those are still yours.

Where this came from

This is one tool out of module 1 of Vault Course, which is eight written lessons that take you from "I could probably teach that" to a folder you can zip and sell. The script is the last thing in it, and it is the part I would give away first, so here it is.

If you want the eight lessons, the four templates, the six prompts and the three worked examples, they are on the page you came from. If you only ever use the script, that is a fine outcome and it is why it is a whole file rather than a screenshot.

Download check-vault.py (free, no email) See the full module it comes from