SOUND THE SEA

Using Apple Shortcuts to run scripts

Jan 27, 2024

I recently had a minor argument with Apple Shortcuts about running a Python script. In the end the solution was simple so I thought I'd share it here.

My goal was to have a simple way converting downloaded bank statements in CSV format to the CSV format that YNAB, or You Need a Budget, expects. I've made it so this shortcut is available when I right click a file in the Finder.

The specifics of the script isn't important but here's an abbreviated version of it to give you a basic boilerplate to start from:

import os
import csv
import sys
import locale

input_file_path = sys.argv[1]
input_file_name = os.path.basename(input_file_path)
input_file_dir = os.path.dirname(input_file_path)
output_file = os.path.join(input_file_dir, "ynab-" + input_file_name)

with open(input_file_path, "r") as file, open(output_file, "w") as out:
  reader = csv.reader(file, delimiter=';')
  writer = csv.writer(out, delimiter=',', quoting=csv.QUOTE_NONNUMERIC)
  header = next(reader)

  writer.writerow(["Date","Payee","Memo","Outflow","Inflow"])

There's a couple useful parts to this in conjuction with Shortcuts:

  • The script reads the input file name as sys.argv[1]
  • It takes the input file name and prepends ynab- to distinguish the converted file

I recommend getting your script working from the terminal before you try to use it in Shortcuts; sometimes Shortcuts will just silence any errors completely and sometimes it'll show you what's wrong but it's much clearer to figure that out from a command line or a debugger. Run the script with:

python script.py input_file.csv

If all goes well it should write a ynab-input_file.csv file.

Now to get your script into the context menu of Finder!

Open the Shortcuts app on your Mac and create a new Shortcut:

  1. Add a Run Shell Script action
  2. Choose python3 as your Shell and select to Pass Input as arguments
  3. Paste in your working Python script

Then, in the info pane of your Action, select to Use as Quick Action in the Finder.

That's it. You're done. When you right click the file you should see your new action under the sub menu Quick Actions.

If, like me, you have a problem where your script silently fails to run, try giving Finder full disk access on your Mac: open System Settings, search for Full Disk Access and add Finder to the list of apps with access to your whole disk.