yaqn 1.8.0

A quicknotes app made in python and tkinter.

YAQN - Yet Another Quick Note

A fast, easy and OOTB app for taking your notes made in Python.

Installation

> pip install yaqn  # Install from pypi
> yaqn --check # Run the app and generate the config file

How to use

Run the yaqn command, it will open the app. To save the note and close the app itself just press Ctrl + Enter.

Open with a keyboard shortcut

This can't be done automatically by pip, please use the correct for your OS:

• MacOS: Use Karabiner Elements and import this rule. This should work in any standard python installation, if you a using pyenv or similar this rule should be modified manually.
• Windows: Too complex too configure unfortunately...
• Linux, FreeBSD and others depend of the window manager you're using.

Configuration

Your configuration file is saved by default in:

• Unix-like: ~/.config/yaqn/config.toml
• Windows: %AppData%\yaqn\config.toml

Custom config path

You can use your custom path for the config using --config:

> yaqn ---config /path/to/config/directory

Check the config file integrity

The argument --check allows you to create, check and repair the config file, just run the command and it will analyze the config:

> yaqn --check
[ INFO ] Check mode -> Config checked and operative

Configuration structure

An ordinary config file looks like this:

notes_path = '/path/to/notes/directory'
extension = 'md'

And this is its structure:

Parameter	Description
notes_path	Define the path to the directory the notes will be saved. You can use the word default to point to the generic notes path.
extension	Define the extension the notes will be saves. Remember to not put . before the extension itself.
no_whitespaces	Define if YAQN should convert all whitespaces to hyphens - in the file name.
no_uppercase	Define if YAQN should convert all uppercase letters to lowercase.
no_firstline	Define if YAQN should remove the first line of the note before save it (useful with apps like ObsidianMD).

Restore configuration to default

Use the command yaqn --restore to regenerate the configuration with its defaults values.

Author

Created with :heart: by Kutu.

• GitHub - kutu-dev
• Twitter - @kutu_dev

Logo of the app created by vladlucha (account deleted unfortunately) in MacOS Icons.