# YAQN - Yet Another Quick Note
> A fast, easy and OOTB app for taking your notes made in Python.
<img src="https://raw.githubusercontent.com/kutu-dev/yaqn/master/assets/screenshots/app.png" alt="Screenshot of the app" width=542>
## 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](https://karabiner-elements.pqrs.org/) and import [this rule](https://github.com/kutu-dev/yaqn/tree/master/assets/karabiner-rules/open-yaqn.json). 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](https://obsidian.md/)). |
### Restore configuration to default
Use the command `yaqn --restore` to regenerate the configuration with its defaults values.
## Author
Created with :heart: by [Kutu](https://kutu-dev.github.io/).
> - GitHub - [kutu-dev](https://github.com/kutu-dev)
> - Twitter - [@kutu_dev](https://twitter.com/kutu_dev)
Logo of the app created by [vladlucha](https://macosicons.com/#/u/vladlucha) (account deleted unfortunately) in [MacOS Icons](https://macosicons.com/#/).
Raw data
{
"_id": null,
"home_page": "https://github.com/kutu-dev/yaqn",
"name": "yaqn",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "notes,utility,portable",
"author": "kutu-dev",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/20/1c/af8f9c1dc3b5cffc3daf5fac706e584152b304c97aa4d887034a958ac197/yaqn-1.9.0.tar.gz",
"platform": null,
"description": "# YAQN - Yet Another Quick Note\n> A fast, easy and OOTB app for taking your notes made in Python.\n\n<img src=\"https://raw.githubusercontent.com/kutu-dev/yaqn/master/assets/screenshots/app.png\" alt=\"Screenshot of the app\" width=542>\n\n## Installation\n```\n> pip install yaqn # Install from pypi\n> yaqn --check # Run the app and generate the config file\n```\n\n## How to use\nRun the `yaqn` command, it will open the app. To save the note and close the app itself just press `Ctrl + Enter`.\n\n### Open with a keyboard shortcut\nThis can't be done automatically by `pip`, please use the correct for your OS:\n- MacOS: Use [Karabiner Elements](https://karabiner-elements.pqrs.org/) and import [this rule](https://github.com/kutu-dev/yaqn/tree/master/assets/karabiner-rules/open-yaqn.json). This should work in any standard python installation, if you a using `pyenv` or similar this rule should be modified manually.\n- Windows: _Too complex too configure unfortunately..._\n- Linux, FreeBSD and others depend of the window manager you're using.\n\n## Configuration\nYour configuration file is saved by default in:\n- Unix-like: `~/.config/yaqn/config.toml`\n- Windows: `%AppData%\\yaqn\\config.toml`\n\n### Custom config path\nYou can use your custom path for the config using `--config`:\n```\n> yaqn --config /path/to/config/directory\n```\n### Check the config file integrity\nThe argument `--check` allows you to create, check and repair the config file, just run the command and it will analyze the config:\n```\n> yaqn --check\n[ INFO ] Check mode -> Config checked and operative\n```\n\n### Configuration structure\nAn ordinary config file looks like this:\n```\nnotes_path = '/path/to/notes/directory'\nextension = 'md'\n```\nAnd this is its structure:\n\n| Parameter | Description |\n| --- | --- |\n| `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. |\n| `extension` | Define the extension the notes will be saves. _Remember to **not** put `.` before the extension itself._ |\n| `no_whitespaces` |\u00a0Define if YAQN should convert all whitespaces to hyphens `-` in the file name. |\n| `no_uppercase` |\u00a0Define if YAQN should convert all uppercase letters to lowercase. |\n| `no_firstline` | Define if YAQN should remove the first line of the note before save it (useful with apps like [ObsidianMD](https://obsidian.md/)). |\n\n### Restore configuration to default\nUse the command `yaqn --restore` to regenerate the configuration with its defaults values.\n\n## Author\n\nCreated with :heart: by [Kutu](https://kutu-dev.github.io/).\n> - GitHub - [kutu-dev](https://github.com/kutu-dev)\n> - Twitter - [@kutu_dev](https://twitter.com/kutu_dev)\n\nLogo of the app created by [vladlucha](https://macosicons.com/#/u/vladlucha) (account deleted unfortunately) in [MacOS Icons](https://macosicons.com/#/).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A quicknotes app made in python and tkinter.",
"version": "1.9.0",
"split_keywords": [
"notes",
"utility",
"portable"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "063c53d5401e2211238750ad93a0a978",
"sha256": "5cfac83cc27b14c9e1d74b66b0ff6a45b93545bca34019774c4cd2114ae62051"
},
"downloads": -1,
"filename": "yaqn-1.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "063c53d5401e2211238750ad93a0a978",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 46450,
"upload_time": "2022-12-24T18:35:29",
"upload_time_iso_8601": "2022-12-24T18:35:29.229918Z",
"url": "https://files.pythonhosted.org/packages/49/6d/4cb420eff0624fccb93c954d1e43c62de8543c72c88ac1dbbd13dc219845/yaqn-1.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "2169749daf24162a74ac0fce9ea29b64",
"sha256": "de06b30f5073d5f737acb84036f417ab0ea40916c70476b36e25612559a8deb3"
},
"downloads": -1,
"filename": "yaqn-1.9.0.tar.gz",
"has_sig": false,
"md5_digest": "2169749daf24162a74ac0fce9ea29b64",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 46962,
"upload_time": "2022-12-24T18:35:30",
"upload_time_iso_8601": "2022-12-24T18:35:30.380988Z",
"url": "https://files.pythonhosted.org/packages/20/1c/af8f9c1dc3b5cffc3daf5fac706e584152b304c97aa4d887034a958ac197/yaqn-1.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-24 18:35:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "kutu-dev",
"github_project": "yaqn",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "yaqn"
}
JSON
