Package: macnotesapp
MacNotesAppWork with Apple MacOS Notes.app from the command line. Also includes python interface for scripting Notes.app from your own python code.InstallationIf you just want to use the command line tool, the easiest option is to install viapipx.If you usepipx, you will not need to create a python virtual environment aspipxtakes care of this. The easiest way to do this on a Mac is to usehomebrew:OpenTerminal(search forTerminalin Spotlight or look inApplications/Utilities)Installhomebrewaccording to instructions athttps://brew.sh/Type the following into Terminal:brew install pipxThen type this:pipx install macnotesapppipxwill install themacnotesappcommand line interface (CLI) as an executable namednotesNow you should be able to runnotesby typing:notesOnce you've installed macnotesapp with pipx, to upgrade to the latest version:pipx upgrade macnotesappNote: Currently tested on MacOS 10.15.7/Catalina and 13.1/Ventura.DocumentationFull documentation available athttps://RhetTbull.github.io/macnotesapp/Command Line UsageUsage: notes [OPTIONS] COMMAND [ARGS]...

  notes: work with Apple Notes on the command line.

Options:
  -v, --version  Show the version and exit.
  -h, --help     Show this message and exit.

Commands:
  accounts  Print information about Notes accounts.
  add       Add new note.
  cat       Print one or more notes to STDOUT
  config    Configure default settings for account, editor, etc.
  dump      Dump all notes or selection of notes for debugging
  help      Print help; for help on commands: help <command>.
  list      List notes, optionally filtering by account or text.Usenotes help COMMANDto get help on a specific command. For example,notes help add:Usage: notes add [OPTIONS] NOTE

  Add new note.

  There are multiple ways to add a new note:

  Add a new note from standard input (STDIN):

  notes add

  cat file.txt | notes add

  notes add < file.txt

  Add a new note by passing string on command line:

  notes add NOTE

  Add a new note by opening default editor (defined in $EDITOR or via `notes
  config`):

  notes add --edit

  notes add -e

  Add a new note from URL (downloads URL, creates a cleaned readable version
  to store in new Note):

  notes add --url URL

  notes add -u URL

  If NOTE is a single line, adds new note with name NOTE and no body. If NOTE is
  more than one line, adds new note where name is first line of NOTE and body is
  remainder.

  Body of note must be plain text unless --html/-h or --markdown/-m
  flag is set in which case body should be HTML or Markdown, respectively. If
  --edit/-e flag is set, note will be opened in default editor before
  being added. If --show/-s flag is set, note will be shown in Notes.app
  after being added.

  Account and top level folder may be specified with --account/-a and
  --folder/-f, respectively. If not provided, default account and folder
  are used.

Options:
  -s, --show             Show note in Notes after adding.
  -F, --file FILENAME
  -u, --url URL
  -h, --html             Use HTML for body of note.
  -m, --markdown         Use Markdown for body of note.
  -p, --plaintext        Use plaintext for body of note (default unless changed
                         in `notes config`).
  -e, --edit             Edit note text before adding in default editor.
  -a, --account ACCOUNT  Add note to account ACCOUNT.
  -f, --folder FOLDER    Add note to folder FOLDER.
  --help                 Show this message and exit.Python Usage"""Example code for working with macnotesapp"""frommacnotesappimportNotesApp# NotesApp() provides interface to Notes.appnotesapp=NotesApp()# Get list of notes (Note objects for each note)notes=notesapp.notes()note=notes[0]print(note.id,note.account,note.folder,note.name,note.body,note.plaintext,note.password_protected,)print(note.asdict())# Get list of notes for one or more specific accountsnotes=notesapp.notes(accounts=["iCloud"])# Create a new note in default folder of default accountnew_note=notesapp.make_note(name="New Note",body="This is a new note created with #macnotesapp")# Create a new note in a specific folder of a specific accountaccount=notesapp.account("iCloud")account.make_note("My New Note","This is a new note created with #macnotesapp",folder="Notes")# If working with many notes, it is far more efficient to use the NotesList object# Find all notes with "#macnotesapp" in the bodynoteslist=notesapp.noteslist(body=["#macnotesapp"])print(f"There are{len(noteslist)}notes with #macnotesapp in the body")# List of names of notes in noteslistnote_names=noteslist.nameprint(note_names)Known Issues and LimitationsPassword protected notes are not supported; unlocked password-protected notes can be accessed but locked notes cannotNotes containing tags (#tagname) can be read but the tags will be stripped from the body of the noteTags cannot be added to notes and will show up as plaintext if added manually with macnotesappCurrently, only notes in top-level folders are accessible tomacnotesapp(#4)Attachments are not currently handled and will be ignored (#15)The title style is not correctly set (#13)