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
pyenvor 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 ❤️ by Kutu.
Logo of the app created by vladlucha (account deleted unfortunately) in MacOS Icons.
1 maintainer
Metadata
1 maintainer
Release files for yaqn 1.9.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| yaqn-1.9.0.tar.gz | 47.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| yaqn-1.9.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 93.4 kB
Release files / yaqn-1.9.0.tar.gz
| Download URL | yaqn-1.9.0.tar.gz |
|---|---|
| Size | 47.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
de06b30f5073d5f737acb84036f417ab0ea40916c70476b36e25612559a8deb3
|
|
BLAKE2b-256 checksum How to use checksums |
201caf8f9c1dc3b5cffc3daf5fac706e584152b304c97aa4d887034a958ac197
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.2 CPython/3.11.0 Darwin/22.1.0
|
Release files / yaqn-1.9.0-py3-none-any.whl
| Download URL | yaqn-1.9.0-py3-none-any.whl |
|---|---|
| Size | 46.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5cfac83cc27b14c9e1d74b66b0ff6a45b93545bca34019774c4cd2114ae62051
|
|
BLAKE2b-256 checksum How to use checksums |
496d4cb420eff0624fccb93c954d1e43c62de8543c72c88ac1dbbd13dc219845
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.2 CPython/3.11.0 Darwin/22.1.0
|
