DiracX Command-Line Interface

0.0.12 · active · verified Sat Apr 11

diracx-cli is the command-line interface component of DiracX, the next-generation distributed computing platform. DiracX is a modern successor to the DIRAC framework, featuring a microservices architecture, token-based authentication, and a focus on usability and extensibility for managing scientific workflows and data. As part of a rapidly evolving project, diracx-cli provides command-line access to its functionalities, leveraging a modular Python package structure.

Warnings

breaking A recent refactor in diracx-cli renamed 'read_config()' to 'read()'. Code relying on the old method will break.
Fix: Update calls from `read_config()` to `read()`.
gotcha The DiracX project, including diracx-cli, is described as 'incomplete' and 'rapidly evolving'. This implies frequent changes, potentially including breaking ones, and evolving documentation.
Fix: Refer frequently to the official GitHub repository and documentation for the latest changes and best practices.
gotcha diracx-cli is part of the 'diracx' namespace package. This means individual components like 'diracx-core', 'diracx-client', etc., are separate PyPI packages that must be installed independently if their functionality is required, rather than being included with a single 'diracx' installation.
Fix: Ensure all necessary 'diracx-*' packages are installed explicitly via pip based on the required functionality.

Install

pip install diracx-cli Install with pip

Imports

app
```
from diracx.cli.main import app
```
diracx-cli is part of the 'diracx' namespace package. Main CLI application object is typically named 'app'.

Quickstart

This quickstart demonstrates how a simple command-line application using Typer, similar to how diracx-cli commands are structured, can be defined and run. In a full DiracX environment, these commands would be integrated and executed via the main 'dirac' command-line entry point. This example simulates a basic 'hello' command.

import typer

app = typer.Typer()

@app.command()
def hello(name: str = "World"):
    "Say hello to NAME."
    print(f"Hello {name}!")

if __name__ == "__main__":
    # In a typical DiracX installation, 'dirac' is the entry point
    # and would automatically discover and run commands. 
    # This snippet shows a runnable Typer app as a minimal example.
    app()

view raw JSON →