{"id":20812329,"url":"https://github.com/kutu-dev/yaqn","last_synced_at":"2025-12-24T12:17:39.054Z","repository":{"id":64308542,"uuid":"571143353","full_name":"kutu-dev/yaqn","owner":"kutu-dev","description":"A quicknote app made in python and tkinter.","archived":false,"fork":false,"pushed_at":"2023-03-20T19:52:14.000Z","size":373,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-09-07T17:35:35.970Z","etag":null,"topics":["notes-app","tkinter","tkinter-gui"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kutu-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-27T10:05:16.000Z","updated_at":"2024-06-06T15:22:05.000Z","dependencies_parsed_at":"2025-01-18T14:51:59.268Z","dependency_job_id":"8f430f4c-f45a-4f4d-973d-8e65e9c2f45b","html_url":"https://github.com/kutu-dev/yaqn","commit_stats":{"total_commits":48,"total_committers":2,"mean_commits":24.0,"dds":0.125,"last_synced_commit":"e60cd0f35f8c79408f4313f52c66e9ec774d4c3a"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/kutu-dev/yaqn","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kutu-dev%2Fyaqn","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kutu-dev%2Fyaqn/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kutu-dev%2Fyaqn/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kutu-dev%2Fyaqn/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kutu-dev","download_url":"https://codeload.github.com/kutu-dev/yaqn/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kutu-dev%2Fyaqn/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28002289,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-24T02:00:07.193Z","response_time":83,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["notes-app","tkinter","tkinter-gui"],"created_at":"2024-11-17T20:53:02.566Z","updated_at":"2025-12-24T12:17:39.036Z","avatar_url":"https://github.com/kutu-dev.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# YAQN - Yet Another Quick Note\n\u003e A fast, easy and OOTB app for taking your notes made in Python.\n\n\u003cimg src=\"https://raw.githubusercontent.com/kutu-dev/yaqn/master/assets/screenshots/app.png\" alt=\"Screenshot of the app\" width=542\u003e\n\n## Installation\n```\n\u003e pip install yaqn  # Install from pypi\n\u003e 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\u003e 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\u003e yaqn --check\n[ INFO ] Check mode -\u003e 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` | Define if YAQN should convert all whitespaces to hyphens `-` in the file name. |\n| `no_uppercase` | Define 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\u003e - GitHub - [kutu-dev](https://github.com/kutu-dev)\n\u003e - 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkutu-dev%2Fyaqn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkutu-dev%2Fyaqn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkutu-dev%2Fyaqn/lists"}