| Name | pickr JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | https://github.com/fpgmaas/peaks |
| Summary | Organize and run frequently used commands |
| upload_time | 2022-12-20 07:54:54 |
| 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">
<h1>peaks</h1>
</p>
---
[](https://img.shields.io/github/v/release/fpgmaas/peaks)
[](https://github.com/fpgmaas/peaks/actions/workflows/main.yml?query=branch%3Amain)
[](https://pypi.org/project/peaks/)
[](https://codecov.io/gh/fpgmaas/peaks)
[](https://pypistats.org/packages/peaks)
[](https://img.shields.io/github/license/fpgmaas/peaks)
_peaks_ is a command line utility to help you organise and quickly run frequently used commands.
<p align="center">
<img src="docs/peaks.gif"/>
</p>
## Quickstart
### Installation
_peaks_ can be installed by running
```shell
pip install peaks
```
To get started, run
```shell
peaks init
```
which will prompt to add a `peaks/peaks.yaml` file in the user's home directory for global commands, and/or a `peaks.yaml` file in the current directory for commands specific to the current project.
To use _peaks_ to run any of the pre-configured commands, simply run
```
peaks
```
For more information, see the [documentation](https://fpgmaas.github.io/peaks/).
## Configuration
_peaks_ can look for configuration in the following two locations:
- In a `peaks.yaml` file in the current directory
- In any `.yaml` file in the the global configuration directory, which is defaulted to `~/peaks`, but which can be overridden with the environment variable `peaks_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, _peaks_ 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/peaks/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/peaks",
"name": "pickr",
"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/b0/eb/bab18ddfe847f09c6eb4864a7d5d40bae1b7203de8de76473774435ca4d6/pickr-0.0.1.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <h1>peaks</h1>\n</p>\n\n---\n\n[](https://img.shields.io/github/v/release/fpgmaas/peaks)\n[](https://github.com/fpgmaas/peaks/actions/workflows/main.yml?query=branch%3Amain)\n[](https://pypi.org/project/peaks/)\n[](https://codecov.io/gh/fpgmaas/peaks)\n[](https://pypistats.org/packages/peaks)\n[](https://img.shields.io/github/license/fpgmaas/peaks)\n\n_peaks_ is a command line utility to help you organise and quickly run frequently used commands.\n\n<p align=\"center\">\n<img src=\"docs/peaks.gif\"/>\n</p>\n\n## Quickstart\n\n### Installation\n\n_peaks_ can be installed by running\n\n```shell\npip install peaks\n```\n\nTo get started, run\n\n```shell\npeaks init\n```\n\nwhich will prompt to add a `peaks/peaks.yaml` file in the user's home directory for global commands, and/or a `peaks.yaml` file in the current directory for commands specific to the current project. \n\nTo use _peaks_ to run any of the pre-configured commands, simply run\n\n```\npeaks\n```\n\nFor more information, see the [documentation](https://fpgmaas.github.io/peaks/).\n\n## Configuration\n\n_peaks_ can look for configuration in the following two locations:\n\n- In a `peaks.yaml` file in the current directory\n- In any `.yaml` file in the the global configuration directory, which is defaulted to `~/peaks`, but which can be overridden with the environment variable `peaks_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, _peaks_ 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/peaks/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.0.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "20d4b2cd4488e3705acacaf49e4c4ba3",
"sha256": "150679afbc308c3f87207062c4b7931453372531a638a09f5f3c308c28c2ad3a"
},
"downloads": -1,
"filename": "pickr-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "20d4b2cd4488e3705acacaf49e4c4ba3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<3.12",
"size": 12151,
"upload_time": "2022-12-20T07:54:52",
"upload_time_iso_8601": "2022-12-20T07:54:52.783301Z",
"url": "https://files.pythonhosted.org/packages/fe/85/e5b65fd0eb444caae6c105b03a801c4259491a3bfe0fc1e88eeadffa877e/pickr-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "b4a2cf0116107e5b4692a9d0977b5088",
"sha256": "492c66227a787b2a43ca8ca3ac4954af96150718714c3bd08f1e3cf6e52f2855"
},
"downloads": -1,
"filename": "pickr-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "b4a2cf0116107e5b4692a9d0977b5088",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<3.12",
"size": 9407,
"upload_time": "2022-12-20T07:54:54",
"upload_time_iso_8601": "2022-12-20T07:54:54.259826Z",
"url": "https://files.pythonhosted.org/packages/b0/eb/bab18ddfe847f09c6eb4864a7d5d40bae1b7203de8de76473774435ca4d6/pickr-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-20 07:54:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "fpgmaas",
"github_project": "peaks",
"lcname": "pickr"
}
