Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix typo in the cli help message #122

Merged
merged 4 commits into from
Aug 28, 2024
Merged

Fix typo in the cli help message #122

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9532e08
Add support for parsable output
ekouts Aug 27, 2024
1a73f3c
Add alias `--json` to `--raw` option
ekouts Aug 28, 2024
138179e
Fix typo in description
ekouts Aug 28, 2024
92e1312
Merge branch 'main' of github.com:eth-cscs/pyfirecrest into feat/cli_raw
ekouts Aug 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions firecrest/cli/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ def services(
name: Optional[str] = typer.Option(
None, "-n", "--name", help="Get information for only one service."
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Provides information for the services of FirecREST"""
try:
Expand Down Expand Up @@ -156,7 +156,7 @@ def systems(
name: Optional[str] = typer.Option(
None, "-n", "--name", help="Get information for only one system."
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Provides information for the available systems in FirecREST"""
try:
Expand Down Expand Up @@ -186,7 +186,7 @@ def systems(

@app.command(rich_help_panel="Status commands")
def parameters(
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Configurable parameters of FirecREST"""
try:
Expand Down Expand Up @@ -233,7 +233,7 @@ def filesystems(
help="The name of the system where the filesystems belongs to.",
envvar="FIRECREST_SYSTEM",
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Information about the filesystems that are available through FirecREST"""
try:
Expand Down Expand Up @@ -266,7 +266,7 @@ def tasks(
pager: Optional[bool] = typer.Option(
True, help="Display the output in a pager application."
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Retrieve information about the FirecREST tasks of the users"""
try:
Expand Down Expand Up @@ -327,7 +327,7 @@ def ls(
"--recursive",
help="Recursively list directories encountered.",
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""List directory contents"""
try:
Expand Down Expand Up @@ -583,7 +583,7 @@ def stat(
),
path: str = typer.Argument(..., help="The absolute target path."),
deref: bool = typer.Option(False, "-L", "--dereference", help="Follow links."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Use the stat linux application to determine the status of a file on the system's filesystem"""
try:
Expand Down Expand Up @@ -1434,7 +1434,7 @@ def poll(
None,
help="End time (and/or date) of job's query. Allowed formats are `HH:MM\[:SS] \[AM|PM]` or `MMDD\[YY]` or `MM/DD\[/YY]` or `MM.DD\[.YY]` or `MM/DD\[/YY]-HH:MM\[:SS]` or `YYYY-MM-DD\[THH:MM\[:SS]]`.",
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Retrieve information about submitted jobs.
This call uses the `sacct` command
Expand Down Expand Up @@ -1477,7 +1477,7 @@ def poll_active(
jobs: Optional[List[str]] = typer.Argument(
None, help="List of job IDs to display."
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Retrieves information about active jobs.
This call uses the `squeue -u <username>` command
Expand Down Expand Up @@ -1520,7 +1520,7 @@ def get_nodes(
nodes: Optional[List[str]] = typer.Argument(
None, help="List of specific compute nodes to query."
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Retrieves information about the compute nodes.
This call uses the `scontrol show nodes` command
Expand Down Expand Up @@ -1568,7 +1568,7 @@ def get_partitions(
partitions: Optional[List[str]] = typer.Argument(
None, help="List of specific partitions to query."
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Retrieves information about the partitions.
This call uses the `scontrol show partitions` command
Expand Down Expand Up @@ -1637,7 +1637,7 @@ def get_reservations(
reservations: Optional[List[str]] = typer.Argument(
None, help="List of specific reservations to query."
),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output json format."),
raw: bool = typer.Option(False, "--json", "--raw", help="Print the output in json format."),
):
"""Retrieves information about the reservations.
This call uses the `scontrol show reservations` command
Expand Down
Loading