| Name | ckit JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | https://github.com/fpgmaas/ckit |
| Summary | Organize and run frequently used commands |
| upload_time | 2023-03-27 10:18:45 |
| maintainer | |
| docs_url | None |
| author | Florian Maas |
| requires_python | >=3.8,<3.12 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img alt="ckit logo" width="460" height="300" src="https://raw.githubusercontent.com/fpgmaas/ckit/main/docs/static/ckit-logo.svg">
</p>
---
[](https://img.shields.io/github/v/release/fpgmaas/ckit)
[](https://github.com/fpgmaas/ckit/actions/workflows/main.yml?query=branch%3Amain)
[](https://pypi.org/project/ckit/)
[](https://codecov.io/gh/fpgmaas/ckit)
[](https://pypistats.org/packages/ckit)
[](https://img.shields.io/github/license/fpgmaas/ckit)
_ckit_ is a command line utility to help you organise and quickly run frequently used commands.
<p align="center">
<img src="docs/static/ckit.gif"/>
</p>
---
<p align="center">
<a href="https://fpgmaas.github.io/ckit">Documentation</a> - <a href="https://github.com/fpgmaas/ckit-files/">Example configuration files</a>
</p>
---
## Quickstart
### Installation
_ckit_ can be installed by running
```shell
pip install ckit
```
To get started, run
```bash
ckit init
```
which will prompt to add a `ckit/ckit.yaml` file in the user's home directory for global commands, and/or a `ckit.yaml` file in the current directory for commands specific to the current project. Alternatively, run
```bash
ckit init --download-global-defaults
```
to get started with a richer set of examples in the global configuration directory, see [ckit-files](https://github.com/fpgmaas/ckit-files/).
To use _ckit_ to run any of the pre-configured commands, simply run
```
ckit
```
## Configuration
_ckit_ can look for configuration in the following two locations:
- In a `ckit.yaml` file in the current directory
- In any `.yaml` file in the the global configuration directory, which is defaulted to `~/ckit`, but which can be overridden with the environment variable `CKIT_HOME`.
An example `.yaml` file could look as follows:
```yaml
test:
my-command:
cmd: "echo Hello! My name is: $name. My favourite fruit is: $fruit"
echo: false
args:
- name
- fruit: apple
```
Which adds the command group `test` wth a single command called `my-command`. When `my-command` is selected to be run, _ckit_ prompts the user for `name` and `fruit` before running the command specified in `cmd`, where `fruit` is defaulted to `apple` if the user does not give any input.
For more details, see the [configuration](https://fpgmaas.github.io/ckit/configuration) section of the documentation.
---
Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).
Raw data
{
"_id": null,
"home_page": "https://github.com/fpgmaas/ckit",
"name": "ckit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<3.12",
"maintainer_email": "",
"keywords": "",
"author": "Florian Maas",
"author_email": "fpgmaas@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/99/16/f0aabcb29a1e54fd1bffd4ee1555668c236863ebebc8b66e53c33050d798/ckit-0.3.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img alt=\"ckit logo\" width=\"460\" height=\"300\" src=\"https://raw.githubusercontent.com/fpgmaas/ckit/main/docs/static/ckit-logo.svg\">\n</p>\n\n---\n\n[](https://img.shields.io/github/v/release/fpgmaas/ckit)\n[](https://github.com/fpgmaas/ckit/actions/workflows/main.yml?query=branch%3Amain)\n[](https://pypi.org/project/ckit/)\n[](https://codecov.io/gh/fpgmaas/ckit)\n[](https://pypistats.org/packages/ckit)\n[](https://img.shields.io/github/license/fpgmaas/ckit)\n\n_ckit_ is a command line utility to help you organise and quickly run frequently used commands.\n\n<p align=\"center\">\n<img src=\"docs/static/ckit.gif\"/>\n</p>\n\n---\n<p align=\"center\">\n <a href=\"https://fpgmaas.github.io/ckit\">Documentation</a> - <a href=\"https://github.com/fpgmaas/ckit-files/\">Example configuration files</a>\n</p>\n\n---\n\n## Quickstart\n\n### Installation\n\n_ckit_ can be installed by running\n\n```shell\npip install ckit\n```\n\nTo get started, run\n\n```bash\nckit init\n```\n\nwhich will prompt to add a `ckit/ckit.yaml` file in the user's home directory for global commands, and/or a `ckit.yaml` file in the current directory for commands specific to the current project. Alternatively, run\n\n```bash\nckit init --download-global-defaults\n```\n\nto get started with a richer set of examples in the global configuration directory, see [ckit-files](https://github.com/fpgmaas/ckit-files/).\n\nTo use _ckit_ to run any of the pre-configured commands, simply run\n\n```\nckit\n```\n\n## Configuration\n\n_ckit_ can look for configuration in the following two locations:\n\n- In a `ckit.yaml` file in the current directory\n- In any `.yaml` file in the the global configuration directory, which is defaulted to `~/ckit`, but which can be overridden with the environment variable `CKIT_HOME`.\n\nAn example `.yaml` file could look as follows:\n\n```yaml\ntest:\n my-command:\n cmd: \"echo Hello! My name is: $name. My favourite fruit is: $fruit\"\n echo: false\n args:\n - name\n - fruit: apple\n```\n\nWhich adds the command group `test` wth a single command called `my-command`. When `my-command` is selected to be run, _ckit_ prompts the user for `name` and `fruit` before running the command specified in `cmd`, where `fruit` is defaulted to `apple` if the user does not give any input.\n\nFor more details, see the [configuration](https://fpgmaas.github.io/ckit/configuration) section of the documentation.\n\n---\n\nRepository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).\n",
"bugtrack_url": null,
"license": "",
"summary": "Organize and run frequently used commands",
"version": "0.3.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b8acc27442953c36c04d0a80896b5bd91743c0fe542d1f67291d11a130216bc2",
"md5": "e6dae0ed723241cb29fe9e3753d64ec1",
"sha256": "d6f7d68c57c39cea117ebae9fa0892399f32d115fa026365fa39cd17ae338e89"
},
"downloads": -1,
"filename": "ckit-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e6dae0ed723241cb29fe9e3753d64ec1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 15054,
"upload_time": "2023-03-27T10:18:44",
"upload_time_iso_8601": "2023-03-27T10:18:44.606260Z",
"url": "https://files.pythonhosted.org/packages/b8/ac/c27442953c36c04d0a80896b5bd91743c0fe542d1f67291d11a130216bc2/ckit-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9916f0aabcb29a1e54fd1bffd4ee1555668c236863ebebc8b66e53c33050d798",
"md5": "6d14cb49195d3f27db280d1e66836255",
"sha256": "f19a2a7c61575bc22897bf4593236bc1de5aff3616395adeacb33126b5e451a2"
},
"downloads": -1,
"filename": "ckit-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "6d14cb49195d3f27db280d1e66836255",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 11374,
"upload_time": "2023-03-27T10:18:45",
"upload_time_iso_8601": "2023-03-27T10:18:45.730889Z",
"url": "https://files.pythonhosted.org/packages/99/16/f0aabcb29a1e54fd1bffd4ee1555668c236863ebebc8b66e53c33050d798/ckit-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-27 10:18:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "fpgmaas",
"github_project": "ckit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ckit"
}
