minkar

Name	minkar JSON
Version	0.3.1 JSON
	download
home_page	None
Summary	A CLI toolkit to improve development workflow
upload_time	2025-08-12 14:27:01
maintainer	None
docs_url	None
author	Waland2
requires_python	>=3.9
license	MIT License Copyright (c) 2025 Waland2 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Minkar
Minkar is a Python CLI toolkit built with Typer to improve development workflow. It helps with common developer tasks from merging source files to managing frequently used shell commands.

## Installation

```bash
pip install minkar
```

or from source:

```bash
git clone https://github.com/Waland2/Minkar.git
cd minkar
pip install .
```
## Features
* **`minkar get code`** - merge project source files into a single text, with extension filters, exclusion rules, and statistics.
* **`minkar get dir`** - shows the project folder tree in either indented form or using bars (`├──`, `└──`).
* **`minkar get file`** - create a `.zip` archive of a directory with include/exclude rules.
* **`minkar cmd`** - save, edit, delete, and run custom shell commands with argument placeholders.

## Usage examples

Merge all Python and JavaScript files in a project and copy to clipboard:

```bash
minkar get code --langs py,js --recursive
```

Print directory tree with files:

```bash
minkar get dir --include-files --bars
```

Create a zip archive with only `.py` files:

```bash
minkar get file --match "\.py" --output code.zip
```

Save and run a shell command:

```bash
minkar cmd save "git status" --name gst
minkar cmd run gst
```

## CLI Structure

* `minkar get` - project information utilities:
  * `code` - merge source files
  * `dir` - print directory tree
  * `file` - create zip archives
* `minkar cmd` - shell command manager:
  * `save` - save a command
  * `run` - execute a command
  * `edit` - update a command
  * `delete` - remove a command
  * `delete-all` - remove all commands
  * `list` - list all saved commands

## License

This project is licensed under the [MIT License](LICENSE.md).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "minkar",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Waland2",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/a7/b1/577b668e875596cf456bb5358d20ec0085a2baec843486e5e795d2057ae6/minkar-0.3.1.tar.gz",
    "platform": null,
    "description": "# Minkar\nMinkar is a Python CLI toolkit built with Typer to improve development workflow. It helps with common developer tasks from merging source files to managing frequently used shell commands.\n\n## Installation\n\n```bash\npip install minkar\n```\n\nor from source:\n\n```bash\ngit clone https://github.com/Waland2/Minkar.git\ncd minkar\npip install .\n```\n## Features\n* **`minkar get code`** - merge project source files into a single text, with extension filters, exclusion rules, and statistics.\n* **`minkar get dir`** - shows the project folder tree in either indented form or using bars (`\u251c\u2500\u2500`, `\u2514\u2500\u2500`).\n* **`minkar get file`** - create a `.zip` archive of a directory with include/exclude rules.\n* **`minkar cmd`** - save, edit, delete, and run custom shell commands with argument placeholders.\n\n## Usage examples\n\nMerge all Python and JavaScript files in a project and copy to clipboard:\n\n```bash\nminkar get code --langs py,js --recursive\n```\n\nPrint directory tree with files:\n\n```bash\nminkar get dir --include-files --bars\n```\n\nCreate a zip archive with only `.py` files:\n\n```bash\nminkar get file --match \"\\.py\" --output code.zip\n```\n\nSave and run a shell command:\n\n```bash\nminkar cmd save \"git status\" --name gst\nminkar cmd run gst\n```\n\n## CLI Structure\n\n* `minkar get` - project information utilities:\n  * `code` - merge source files\n  * `dir` - print directory tree\n  * `file` - create zip archives\n* `minkar cmd` - shell command manager:\n  * `save` - save a command\n  * `run` - execute a command\n  * `edit` - update a command\n  * `delete` - remove a command\n  * `delete-all` - remove all commands\n  * `list` - list all saved commands\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE.md).\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2025 Waland2\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.\n        ",
    "summary": "A CLI toolkit to improve development workflow",
    "version": "0.3.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "06614c39d9f33f4166ba30f789c64c4b40203e7dfc8cbfb8cda9c39019d0e0c0",
                "md5": "79491078929c27afd8904607c8ed6a3a",
                "sha256": "787ef812d21aa47264dc2636e4059066e0b3396cd5c39e4ee2df79cdac43fb8c"
            },
            "downloads": -1,
            "filename": "minkar-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "79491078929c27afd8904607c8ed6a3a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 11556,
            "upload_time": "2025-08-12T14:27:00",
            "upload_time_iso_8601": "2025-08-12T14:27:00.808203Z",
            "url": "https://files.pythonhosted.org/packages/06/61/4c39d9f33f4166ba30f789c64c4b40203e7dfc8cbfb8cda9c39019d0e0c0/minkar-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a7b1577b668e875596cf456bb5358d20ec0085a2baec843486e5e795d2057ae6",
                "md5": "b83bac619373882a7d51c1f94035d6a3",
                "sha256": "0c6ea653ac5b5217c30b208ec6731e6ce57da4cb43897b6dfb8ddd5e1be2acf9"
            },
            "downloads": -1,
            "filename": "minkar-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b83bac619373882a7d51c1f94035d6a3",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 9756,
            "upload_time": "2025-08-12T14:27:01",
            "upload_time_iso_8601": "2025-08-12T14:27:01.822129Z",
            "url": "https://files.pythonhosted.org/packages/a7/b1/577b668e875596cf456bb5358d20ec0085a2baec843486e5e795d2057ae6/minkar-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-12 14:27:01",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "minkar"
}