Name | idefix-cli JSON |
Version |
6.0.1
JSON |
| download |
home_page | None |
Summary | A command line utility belt for Idefix |
upload_time | 2024-12-15 10:42:04 |
maintainer | None |
docs_url | None |
author | C.M.T. Robert |
requires_python | >=3.10 |
license | GPL-3.0 |
keywords |
|
VCS |
|
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
[![PyPI](https://img.shields.io/pypi/v/idefix_cli.svg?logo=pypi&logoColor=white&label=PyPI)](https://pypi.org/project/idefix-cli/)
[![Documentation Status](https://readthedocs.org/projects/idefix-cli/badge/?version=latest)](https://idefix-cli.readthedocs.io/en/latest/?badge=latest)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/neutrinoceros/idefix_cli/main.svg)](https://results.pre-commit.ci/badge/github/neutrinoceros/idefix_cli/main.svg)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/charliermarsh/ruff)
# `idefix_cli`
`idefix_cli` is a command line utility belt for [Idefix](https://github.com/idefix-code/idefix).
It defines a `idfx` command familly. The builtin command set (`idfx conf`, `idfx run`,
...) can be extended to include arbitrary helper scripts.
## Installation
`idefix_cli` is distributed via the Python Packaging Index (PyPI).
It is recommended to install this tool at the system level, but still in isolation,
using for instance [`uv`](https://docs.astral.sh/uv/) as
```shell
$ uv tool install idefix-cli
```
or [`pipx`](https://pipxproject.github.io/pipx/)
```shell
$ pipx install idefix-cli
```
Otherwise, the most portable way to install the latest stable version is
```shell
$ python -m pip install --user idefix_cli
```
Note that most `idfx` commands explicitly require that the env variable `$IDEFIX_DIR` be
set at runtime.
## Get help
Get a complete description of available commands with
```shell
$ idfx --help
```
Likewise, get help for each command therein as, for instance
```shell
$ idfx run --help
```
For more, read [the documentation !](https://idefix-cli.readthedocs.io/en/latest/?badge=latest)
Raw data
{
"_id": null,
"home_page": null,
"name": "idefix-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "C.M.T. Robert",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/4f/5d/b70a7162f0c9e332689330ba07a502ca4cfd5e0d74a99043bddf11f0d9f3/idefix_cli-6.0.1.tar.gz",
"platform": null,
"description": "[![PyPI](https://img.shields.io/pypi/v/idefix_cli.svg?logo=pypi&logoColor=white&label=PyPI)](https://pypi.org/project/idefix-cli/)\n[![Documentation Status](https://readthedocs.org/projects/idefix-cli/badge/?version=latest)](https://idefix-cli.readthedocs.io/en/latest/?badge=latest)\n[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/neutrinoceros/idefix_cli/main.svg)](https://results.pre-commit.ci/badge/github/neutrinoceros/idefix_cli/main.svg)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/charliermarsh/ruff)\n\n# `idefix_cli`\n\n`idefix_cli` is a command line utility belt for [Idefix](https://github.com/idefix-code/idefix).\n\nIt defines a `idfx` command familly. The builtin command set (`idfx conf`, `idfx run`,\n...) can be extended to include arbitrary helper scripts.\n\n\n## Installation\n\n`idefix_cli` is distributed via the Python Packaging Index (PyPI).\n\nIt is recommended to install this tool at the system level, but still in isolation,\nusing for instance [`uv`](https://docs.astral.sh/uv/) as\n```shell\n$ uv tool install idefix-cli\n```\nor [`pipx`](https://pipxproject.github.io/pipx/)\n```shell\n$ pipx install idefix-cli\n```\n\nOtherwise, the most portable way to install the latest stable version is\n```shell\n$ python -m pip install --user idefix_cli\n```\n\nNote that most `idfx` commands explicitly require that the env variable `$IDEFIX_DIR` be\nset at runtime.\n\n## Get help\n\nGet a complete description of available commands with\n```shell\n$ idfx --help\n```\nLikewise, get help for each command therein as, for instance\n```shell\n$ idfx run --help\n```\n\nFor more, read [the documentation !](https://idefix-cli.readthedocs.io/en/latest/?badge=latest)\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "A command line utility belt for Idefix",
"version": "6.0.1",
"project_urls": {
"Homepage": "https://github.com/neutrinoceros/idefix_cli"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d2bf7a0af63dd742ec22d1ad77230141c01627cbc991ca4ac28524c0cfa28e02",
"md5": "d2e41011bc47184b1e99b90dc3a8267a",
"sha256": "d784a5e45954c4a74d697c2e8aafba0cba3eff8f70e8a5f88a7caeb751d752fb"
},
"downloads": -1,
"filename": "idefix_cli-6.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d2e41011bc47184b1e99b90dc3a8267a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 39311,
"upload_time": "2024-12-15T10:42:02",
"upload_time_iso_8601": "2024-12-15T10:42:02.788670Z",
"url": "https://files.pythonhosted.org/packages/d2/bf/7a0af63dd742ec22d1ad77230141c01627cbc991ca4ac28524c0cfa28e02/idefix_cli-6.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4f5db70a7162f0c9e332689330ba07a502ca4cfd5e0d74a99043bddf11f0d9f3",
"md5": "ed963edbff1dd05ff291528a18318f30",
"sha256": "c39c95a2555a1f5414507677d91f4b7f5e3a1293914c24a7f0efa37a0e5b67d5"
},
"downloads": -1,
"filename": "idefix_cli-6.0.1.tar.gz",
"has_sig": false,
"md5_digest": "ed963edbff1dd05ff291528a18318f30",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 60461,
"upload_time": "2024-12-15T10:42:04",
"upload_time_iso_8601": "2024-12-15T10:42:04.382205Z",
"url": "https://files.pythonhosted.org/packages/4f/5d/b70a7162f0c9e332689330ba07a502ca4cfd5e0d74a99043bddf11f0d9f3/idefix_cli-6.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-15 10:42:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "neutrinoceros",
"github_project": "idefix_cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "idefix-cli"
}