# Kshort
Kshort is a terminal script that allows you to search your projects from the terminal and open them in neovim, it currently works with kitty and gnome-terminal.
## Requirements
- `kitty` [terminal](https://sw.kovidgoyal.net/kitty/) | `gnome-terminal`
- `fzf` [repo](https://github.com/junegunn/fzf)
- `neovim`
## Installation
```shell
pip install kshort
```
## Configuration
Configure the projects in your director `~/.config/projects_manager.json`
- *File structure*
```json
{
"directories": [
{
"name": "PHP",
"directory": "~/code/php",
"icon": "๎ฝ ",
"color": "#5e79be"
},
{
"name": "Javascript",
"directory": "~/code/javascript/",
"icon": "๎ ",
"color": "#ecb75d"
}
],
"projects": [
{
"name": "Neovim",
"directory": "~/.config/nvim",
"icon": "๎
",
"color": "#509a3a"
},
{
"name": "Awesome",
"directory": "~/.config/awesome",
"icon": "๏กน ",
"color": "#535d6c"
}
]
}
```
## Commands
- `kshort` list your projects in fzf and open them in kitty and using neovim
- `kshort -g` list your projects in fzf and open them in gnome-terminal and using neovim
- `kshort --list` returns a list of your configured projects
Raw data
{
"_id": null,
"home_page": "https://github.com/McAlvaro/kshort",
"name": "kshort",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, kshort",
"author": "McAlvaro",
"author_email": "mc.alvaro641@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2d/b8/9f98b25631582f3330bc7fc3a61db6cf77da048328038d4e31de176f3649/kshort-0.0.9.tar.gz",
"platform": null,
"description": "# Kshort\nKshort is a terminal script that allows you to search your projects from the terminal and open them in neovim, it currently works with kitty and gnome-terminal.\n\n## Requirements\n- `kitty` [terminal](https://sw.kovidgoyal.net/kitty/) | `gnome-terminal`\n- `fzf` [repo](https://github.com/junegunn/fzf)\n- `neovim`\n\n## Installation\n\n```shell\npip install kshort\n```\n\n## Configuration\nConfigure the projects in your director `~/.config/projects_manager.json`\n\n- *File structure*\n```json\n{\n \"directories\": [\n {\n \"name\": \"PHP\",\n \"directory\": \"~/code/php\",\n \"icon\": \"\ue73d \",\n \"color\": \"#5e79be\"\n },\n {\n \"name\": \"Javascript\",\n \"directory\": \"~/code/javascript/\",\n \"icon\": \"\ue781 \",\n \"color\": \"#ecb75d\"\n }\n ],\n \"projects\": [\n {\n \"name\": \"Neovim\",\n \"directory\": \"~/.config/nvim\",\n \"icon\": \"\ue7c5 \",\n \"color\": \"#509a3a\"\n },\n {\n \"name\": \"Awesome\",\n \"directory\": \"~/.config/awesome\",\n \"icon\": \"\uf879 \",\n \"color\": \"#535d6c\"\n }\n ]\n}\n```\n\n## Commands\n\n- `kshort` list your projects in fzf and open them in kitty and using neovim\n- `kshort -g` list your projects in fzf and open them in gnome-terminal and using neovim\n- `kshort --list` returns a list of your configured projects\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Module to manage your projects using kitty and neovim",
"version": "0.0.9",
"project_urls": {
"Homepage": "https://github.com/McAlvaro/kshort"
},
"split_keywords": [
"python",
" kshort"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "32d27ac0fcd2d515681bb6525a61f822e638b429a99d0fdc810d232a1463da0d",
"md5": "7dd2f1668ec7d852eeb764cd4c61c671",
"sha256": "5ee48a1a253c4cf286d89c9b7d44e3d88176a4df7bd26fccf20f7f1b8d43f6b2"
},
"downloads": -1,
"filename": "kshort-0.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7dd2f1668ec7d852eeb764cd4c61c671",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5796,
"upload_time": "2024-09-22T00:27:54",
"upload_time_iso_8601": "2024-09-22T00:27:54.852847Z",
"url": "https://files.pythonhosted.org/packages/32/d2/7ac0fcd2d515681bb6525a61f822e638b429a99d0fdc810d232a1463da0d/kshort-0.0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2db89f98b25631582f3330bc7fc3a61db6cf77da048328038d4e31de176f3649",
"md5": "e981d3b49f43c92a4de7a54b792f437d",
"sha256": "507d33712eb59fdf2af2c3e3b38bcf1de3ab422ef5c923ac809731e47ea7531b"
},
"downloads": -1,
"filename": "kshort-0.0.9.tar.gz",
"has_sig": false,
"md5_digest": "e981d3b49f43c92a4de7a54b792f437d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4017,
"upload_time": "2024-09-22T00:28:03",
"upload_time_iso_8601": "2024-09-22T00:28:03.732765Z",
"url": "https://files.pythonhosted.org/packages/2d/b8/9f98b25631582f3330bc7fc3a61db6cf77da048328038d4e31de176f3649/kshort-0.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-22 00:28:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "McAlvaro",
"github_project": "kshort",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "kshort"
}
JSON
