Metadata-Version: 2.1
Name: idefix-cli
Version: 4.0.0
Summary: A command line utility belt for Idefix
Author: C.M.T. Robert
License: GPL-3.0
Project-URL: Homepage, https://github.com/neutrinoceros/idefix_cli
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Typing :: Typed
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: inifix >=4.2.2
Requires-Dist: packaging >=21.0
Requires-Dist: termcolor >=2.3.0
Requires-Dist: typing-extensions >=4.1.0 ; python_version < "3.11"
Provides-Extra: isolated
Requires-Dist: inifix ==4.2.2 ; extra == 'isolated'
Requires-Dist: packaging ==21.0 ; extra == 'isolated'
Requires-Dist: termcolor ==2.3.0 ; extra == 'isolated'
Requires-Dist: typing-extensions ==4.1.0 ; (python_version < "3.11") and extra == 'isolated'

[![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)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![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 in isolation with [`pipx`](https://pipxproject.github.io/pipx/) as
```shell
$ pipx install "idefix_cli[isolated]"
```
(adding `[isolated]` has the effect of pinning dependencies)

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)
