mawhrin 0.2.0

A command-line note file manager in Python.

Mawhrin

Mawhrin is a command-line note file manager, written in Python 3.11 by Stephen Malone. If you have a directory of plaintext note files, Mawhrin can give you a neat & tidy command-line interface to access, edit and organise them.

Installation

You can install Mawhrin using Pip:

pip install mawhrin

Or just download the latest release for your platform.

Configuration

Mawhrin always operates within a directory of plaintext note files you specify, using two environment variables:

# The directory your note files are in.
export MAWHRIN_DIR = "$HOME/notes"

# The extension your note files use (with a leading dot).
export MAWHRIN_EXT = ".txt"

That's it. That's all you need to do.

Commands

Basic syntax

Your notes are always shown as lowercase names, e.g.: Mawhrin will show the note file notes/foo.txt as foo. The opposite is also true: if you ask Mawhrin to create the note foo, it will translate to notes/foo.txt.

For command-line help, call Mawhrin or a command with the the -h or --help options.

List all notes

Use list to see all your notes, or notes with names matching some text:

$ mawhrin list
books_to_read
recipes_pasta
recipes_vegan
todos-2024

$ mawhrin list "2024"
todos-2024

• Matching uses case-insensitive substrings, so TODO will match todos-2024.
• If no matches are found, Mawhrin will print nothing.

Search all notes

Use find to list notes containing some text:

$ mawhrin find "add the tofu"
recipes_vegan

• Searching also uses case-insensitive substrings.
• If no searches are found, Mawhrin will print nothing.

Create a note

Use make to create a new empty note, or a note containing some text:

$ mawhrin make movies_to_watch
# or to add text:
$ mawhrin make movies_to_watch "- [ ] Contact"

• If the note already exists, Mawhrin will print an error.

Print a note

Use show to print the contents of a note, if it exists:

$ mawhrin show books_to_read
- [x] The Player of Games by Iain M. Banks

• If the note doesn't exist, Mawhrin will print nothing.

Contributing

Please submit all bug reports and feature requests to the issue tracker, thank you.