qbraid-cli 0.7.0__py3-none-any.whl → 0.8.0__py3-none-any.whl

qbraid_cli/kernels/app.py

@@ -0,0 +1,111 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module defining commands in the 'qbraid jobs' namespace.
+
+"""
+import sys
+from pathlib import Path
+
+import typer
+from jupyter_client.kernelspec import KernelSpecManager
+from rich.console import Console
+
+from qbraid_cli.envs.data_handling import installed_envs_data
+from qbraid_cli.handlers import handle_error
+
+kernels_app = typer.Typer(help="Manage qBraid kernels.")
+
+
+def _get_kernels_path(environment: str) -> Path:
+    """Get the path to the kernels directory for the given environment."""
+    slug_to_path, name_to_slug = installed_envs_data()
+
+    if environment in name_to_slug:
+        slug = name_to_slug.get(environment, None)
+    else:
+        slug = environment
+
+    if slug not in slug_to_path:
+        raise ValueError(f"Environment '{environment}' not found.")
+
+    env_path = slug_to_path[slug]
+    kernels_path = env_path / "kernels"
+    return kernels_path
+
+
+@kernels_app.command(name="list")
+def kernels_list():
+    """List all available kernels."""
+    console = Console()
+
+    kernel_spec_manager = KernelSpecManager()
+    kernelspecs = kernel_spec_manager.get_all_specs()
+
+    if len(kernelspecs) == 0:
+        console.print("No qBraid kernels are active.")
+        console.print("\nUse 'qbraid kernels add' to add a new kernel.")
+        return
+
+    longest_kernel_name = max(len(kernel_name) for kernel_name in kernelspecs)
+    spacing = longest_kernel_name + 10
+
+    console.print("# qbraid kernels:\n#\n")
+
+    # Ensure 'python3' kernel is printed first if it exists
+    default_kernel_name = "python3"
+    python3_kernel_info = kernelspecs.pop(default_kernel_name, None)
+    if python3_kernel_info:
+        console.print(f"{default_kernel_name.ljust(spacing)}{python3_kernel_info['resource_dir']}")
+
+    # Print the rest of the kernels
+    for kernel_name, kernel_info in sorted(kernelspecs.items()):
+        console.print(f"{kernel_name.ljust(spacing)}{kernel_info['resource_dir']}")
+
+
+@kernels_app.command(name="add")
+def kernels_add(
+    environment: str = typer.Argument(
+        ..., help="Name of environment for which to add ipykernel. Values from 'qbraid envs list'."
+    )
+):
+    """Add a kernel."""
+
+    try:
+        kernels_path = _get_kernels_path(environment)
+    except ValueError:
+        handle_error(message=f"Environment '{environment}' not found.", include_traceback=False)
+        return
+
+    is_local = str(kernels_path).startswith(str(Path.home()))
+    resource_path = str(Path.home() / ".local") if is_local else sys.prefix
+
+    kernel_spec_manager = KernelSpecManager()
+
+    for kernel in kernels_path.iterdir():
+        kernel_spec_manager.install_kernel_spec(source_dir=str(kernel), prefix=resource_path)
+
+
+@kernels_app.command(name="remove")
+def kernels_remove(
+    environment: str = typer.Argument(
+        ...,
+        help=("Name of environment for which to remove ipykernel. Values from 'qbraid envs list'."),
+    )
+):
+    """Remove a kernel."""
+    try:
+        kernels_path = _get_kernels_path(environment)
+    except ValueError:
+        handle_error(message=f"Environment '{environment}' not found.", include_traceback=False)
+        return
+
+    kernel_spec_manager = KernelSpecManager()
+
+    for kernel in kernels_path.iterdir():
+        kernel_spec_manager.remove_kernel_spec(kernel.name)
+
+
+if __name__ == "__main__":
+    kernels_app()

qbraid_cli/main.py

@@ -0,0 +1,80 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Entrypoint for the qBraid CLI.
+
+"""
+
+import typer
+
+from qbraid_cli.admin.app import admin_app
+from qbraid_cli.configure.app import configure_app
+from qbraid_cli.credits.app import credits_app
+from qbraid_cli.devices.app import devices_app
+from qbraid_cli.envs.app import envs_app
+from qbraid_cli.jobs.app import jobs_app
+from qbraid_cli.kernels.app import kernels_app
+
+app = typer.Typer(context_settings={"help_option_names": ["-h", "--help"]})
+
+app.add_typer(admin_app, name="admin")
+app.add_typer(configure_app, name="configure")
+app.add_typer(credits_app, name="credits")
+app.add_typer(devices_app, name="devices")
+app.add_typer(envs_app, name="envs")
+app.add_typer(jobs_app, name="jobs")
+app.add_typer(kernels_app, name="kernels")
+
+
+def version_callback(value: bool):
+    """Show the version and exit."""
+    if value:
+        from ._version import __version__
+
+        typer.echo(f"qbraid-cli/{__version__}")
+        raise typer.Exit()
+
+
+def show_banner():
+    """Show the qBraid CLI banner."""
+    typer.secho("----------------------------------", fg=typer.colors.BRIGHT_BLACK)
+    typer.secho("  * ", fg=typer.colors.BRIGHT_BLACK, nl=False)
+    typer.secho("Welcome to the qBraid CLI!", fg=typer.colors.MAGENTA, nl=False)
+    typer.secho(" * ", fg=typer.colors.BRIGHT_BLACK)
+    typer.secho("----------------------------------", fg=typer.colors.BRIGHT_BLACK)
+    typer.echo("")
+    typer.echo("        ____            _     _  ")
+    typer.echo("   __ _| __ ) _ __ __ _(_) __| | ")
+    typer.echo(r"  / _` |  _ \| '__/ _` | |/ _` | ")
+    typer.echo(" | (_| | |_) | | | (_| | | (_| | ")
+    typer.echo(r"  \__,_|____/|_|  \__,_|_|\__,_| ")
+    typer.echo("     |_|                         ")
+    typer.echo("")
+    typer.echo("")
+    typer.echo("- Use 'qbraid --help' to see available commands.")
+    typer.echo("")
+    typer.echo("- Use 'qbraid --version' to see the current version.")
+    typer.echo("")
+    typer.echo("Reference Docs: https://docs.qbraid.com/projects/cli/en/stable/guide/overview.html")
+
+
+@app.callback(invoke_without_command=True)
+def main(
+    ctx: typer.Context,
+    version: bool = typer.Option(
+        None,
+        "--version",
+        "-v",
+        callback=version_callback,
+        is_eager=True,
+        help="Show the version and exit.",
+    ),
+):
+    """The qBraid CLI."""
+    if ctx.invoked_subcommand is None and not version:
+        show_banner()
+
+
+if __name__ == "__main__":
+    app()

qbraid_cli-0.8.0.dist-info/METADATA

@@ -0,0 +1,143 @@
+Metadata-Version: 2.1
+Name: qbraid-cli
+Version: 0.8.0
+Summary: Command Line Interface for interacting with all parts of the qBraid platform.
+Author-email: qBraid Development Team <contact@qbraid.com>
+License: Proprietary
+Project-URL: Homepage, https://www.qbraid.com/
+Project-URL: Documentation, https://docs.qbraid.com/projects/cli/en/stable/guide/overview.html
+Project-URL: Bug Tracker, https://github.com/qBraid/qBraid-Lab/issues
+Project-URL: Discord, https://discord.gg/KugF6Cnncm
+Project-URL: Launch on Lab, https://account.qbraid.com/?gitHubUrl=https://github.com/qBraid/qBraid-Lab.git
+Keywords: qbraid,cli,quantum,cloud
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: License :: Other/Proprietary License
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: typer >=0.12.1
+Requires-Dist: rich >=10.11.0
+Requires-Dist: jupyter-client <9.0.0,>=7.0.0
+Requires-Dist: ipykernel
+Requires-Dist: qbraid-core >=0.1.4
+Provides-Extra: dev
+Requires-Dist: black ; extra == 'dev'
+Requires-Dist: isort ; extra == 'dev'
+Requires-Dist: pylint ; extra == 'dev'
+Requires-Dist: pytest ; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: sphinx ~=7.2.6 ; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme <2.1,>=1.3 ; extra == 'docs'
+Requires-Dist: docutils <0.22 ; extra == 'docs'
+Requires-Dist: toml ; extra == 'docs'
+Requires-Dist: build ; extra == 'docs'
+Requires-Dist: m2r ; extra == 'docs'
+Requires-Dist: typer ; extra == 'docs'
+Provides-Extra: jobs
+Requires-Dist: amazon-braket-sdk >=1.48.1 ; extra == 'jobs'
+
+<img width="full" alt="qbraid_cli" src="https://qbraid-static.s3.amazonaws.com/logos/qbraid-cli-banner.png">
+
+[![Documentation](https://img.shields.io/badge/Documentation-DF0982)](https://docs.qbraid.com/projects/cli/en/stable/guide/overview.html)
+[![PyPI version](https://img.shields.io/pypi/v/qbraid-cli.svg?color=blue)](https://pypi.org/project/qbraid-cli/)
+[![Python verions](https://img.shields.io/pypi/pyversions/qbraid-cli.svg?color=blue)](https://pypi.org/project/qbraid-cli/)
+[![Downloads](https://static.pepy.tech/badge/qbraid-cli)](https://pepy.tech/project/qbraid-cli)
+[![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/qBraid/qBraid-Lab/issues)
+[![Discord](https://img.shields.io/discord/771898982564626445.svg?color=pink)](https://discord.gg/KugF6Cnncm)
+
+Command Line Interface for interacting with all parts of the qBraid platform.
+
+The **qBraid CLI** is a specialized command-line interface tool designed *exclusively* for use within the [qBraid Lab](https://docs.qbraid.com/projects/lab/en/latest/lab/overview.html) platform. It is not intended for local installations or use outside the qBraid Lab environment. This tool ensures seamless integration and optimized performance specifically tailored for qBraid Lab's unique cloud-based quantum computing ecosystem.
+
+## Getting Started
+
+To use the qBraid CLI, login to qBraid (or create an account), launch Lab, and then open Terminal. You can also access the CLI directly from within [Notebooks](https://docs.qbraid.com/projects/lab/en/latest/lab/notebooks.html) using the ``!`` operator. See [quantum jobs example](https://github.com/qBraid/qbraid-lab-demo/blob/045c7a8fbdcae66a7e64533dd9fe0e981dc02cf4/qbraid_lab/quantum_jobs/aws_quantum_jobs.ipynb).
+
+- [Launch qBraid Lab &rarr;](https://lab.qbraid.com/)
+- [Make an account &rarr;](https://account.qbraid.com/)
+
+For help, see qBraid Lab User Guide: [Getting Started](https://docs.qbraid.com/projects/lab/en/latest/lab/getting_started.html).
+
+## Basic Commands
+
+```shell
+$ qbraid
+----------------------------------
+  * Welcome to the qBraid CLI! * 
+----------------------------------
+
+        ____            _     _  
+   __ _| __ ) _ __ __ _(_) __| | 
+  / _` |  _ \| '__/ _` | |/ _` | 
+ | (_| | |_) | | | (_| | | (_| | 
+  \__,_|____/|_|  \__,_|_|\__,_| 
+     |_|                         
+
+
+- Use 'qbraid --help' to see available commands.
+
+- Use 'qbraid --version' to see the current version.
+
+Reference Docs: https://docs.qbraid.com/projects/cli/en/stable/guide/overview.html
+```
+
+A qBraid CLI command has the following structure:
+
+```shell
+$ qbraid <command> <subcommand> [options and parameters]
+```
+
+For example, to list installed environments, the command would be:
+
+```shell
+$ qbraid envs list
+```
+
+To view help documentation, use one of the following:
+
+```shell
+$ qbraid --help
+$ qbraid <command> --help
+$ qbraid <command> <subcommand> --help
+```
+
+For example:
+
+```shell
+$ qbraid --help
+
+Usage: qbraid [OPTIONS] COMMAND [ARGS]...
+
+The qBraid CLI.
+
+Options
+  --version                     Show the version and exit.
+  --install-completion          Install completion for the current shell.
+  --show-completion             Show completion for the current shell, to copy it or customize the installation.
+  --help                        Show this message and exit.
+
+Commands
+  configure                     Configure qBraid CLI options.
+  credits                       Manage qBraid credits.
+  devices                       Manage qBraid quantum devices.
+  envs                          Manage qBraid environments.
+  jobs                          Manage qBraid quantum jobs.
+  kernels                       Manage qBraid kernels.
+```
+
+To get the version of the qBraid CLI:
+
+```shell
+$ qbraid --version
+```

qbraid_cli-0.8.0.dist-info/RECORD

@@ -0,0 +1,33 @@
+qbraid_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+qbraid_cli/_version.py,sha256=vspFLRfYI6gAAN7kyihey2lhPos0jxqKaNDWFlKPlmU,411
+qbraid_cli/exceptions.py,sha256=KjlhYJhSHMVazaNiBjD_Ur06w4sekP8zRsFzBdyIpno,672
+qbraid_cli/handlers.py,sha256=i3vdRtdy4bZKg3j6fwfVMz1ddhMgzlc2hhmj-vewxpI,6542
+qbraid_cli/main.py,sha256=IRKazFqtFpoiq_xOtqb-IXDKAVs4lacFIRCQCoiGNF4,2503
+qbraid_cli/admin/__init__.py,sha256=Suo_L1_yBodCvLM_fpw8gRIhD4mVVOXKObtxeoMaBVo,150
+qbraid_cli/admin/app.py,sha256=__6lo-iFsbfz-ayD1-AS8X1z_gYhCad1NK17hnrL7HY,1451
+qbraid_cli/admin/headers.py,sha256=oE2Ry9221ZV4tgYqFJNHAPilDw72xR3LqG_gBw7BFxM,6667
+qbraid_cli/admin/validation.py,sha256=LkAVXlHtM0MhCa34MIWrfX59wGXMVlZmdVB4-AQ8fBk,1003
+qbraid_cli/configure/__init__.py,sha256=6GU7vR6JYRGcMsmdrpFbwLO5VSUmnLgwSbtmGWMQND4,158
+qbraid_cli/configure/actions.py,sha256=3rrWHaCAsogyx0Ll-lcjbSzldD4kPuz1z6VQiWebSWw,3203
+qbraid_cli/configure/app.py,sha256=1uRe2lkUA4TtYb5b4mbD4LH-cKCbsZGT3Wfk7fpNzX0,2414
+qbraid_cli/credits/__init__.py,sha256=t-3XAJFAXiu_jI4sgjaIOuNne_AoSYaSEsi-SSRkvPw,154
+qbraid_cli/credits/app.py,sha256=iHikmjx8pylMFNzHckuauOg-Nb9pS7xQq_H75ibVJig,774
+qbraid_cli/devices/__init__.py,sha256=_PU3eMQRV4DkPw-oCmfCPh8EbVmgG76ieEKuNsY9Xqc,154
+qbraid_cli/devices/app.py,sha256=zxSxrEQn7irkJoME4S_CBnRqWeB8cqPaBsIMfpdYFk0,2530
+qbraid_cli/devices/validation.py,sha256=YhShyUufgrKnx2XjXOXF-PqFJYklJT9CgeqIwKcNam4,809
+qbraid_cli/envs/__init__.py,sha256=YgIoMWxfGqzmwfypO5JHYuCOu6BfFwb9NHgQel1IJM8,148
+qbraid_cli/envs/activate.py,sha256=VpvVYSfQDlcmlNWJOgkLIQ2p8YXPPLG8Jbl5t8GHUDw,2140
+qbraid_cli/envs/app.py,sha256=t6bRwJGy-M3PAu870ZsttsM8tpSB0OFasgCJiV9nTSA,8620
+qbraid_cli/envs/create.py,sha256=uCRex_TcFYw26jUOU06Ta5I8Mq5pRqLVaOE6MxrrExs,4337
+qbraid_cli/envs/data_handling.py,sha256=mTVzsj6KleeeYDKGhgD-IesF9KQQMSszKFSEo8Wrv9w,4001
+qbraid_cli/jobs/__init__.py,sha256=bj9XmZ4JL8OtMMZbHIu-DPhpOMXGLSB-W1b0wO7wKro,148
+qbraid_cli/jobs/app.py,sha256=kmg9mYla3Nd7EdjQlFu7IOvm7sejLNfPPA6Qeet-IfE,4898
+qbraid_cli/jobs/toggle_braket.py,sha256=d5C_Di80jWMFlh-77eH8YY9pjMKWXK5abenUDtPlE_I,6662
+qbraid_cli/jobs/validation.py,sha256=xNbjUggMhUs4wzkuRm4PuFPi_wrElYicUgYXLznHz3U,2983
+qbraid_cli/kernels/__init__.py,sha256=VhpBota_v7OoiGxrPCqJU4XBVcolf81mbCYGSxXzVhc,154
+qbraid_cli/kernels/app.py,sha256=ZJWVdKzCDfzGnA1pqp01vDbE7fh8p84jC-y6DDgWlxc,3373
+qbraid_cli-0.8.0.dist-info/METADATA,sha256=pzzAXIOWje3oLOPHOM6F0Va9C6hk1-eKa3HzezY9B8Y,5914
+qbraid_cli-0.8.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+qbraid_cli-0.8.0.dist-info/entry_points.txt,sha256=c5ZJ7NjbxhDqMpou9q5F03_b_KG34HzFDijIDmEIwgQ,47
+qbraid_cli-0.8.0.dist-info/top_level.txt,sha256=LTYJgeYSCHo9Il8vZu0yIPuGdGyNaIw6iRy6BeoZo8o,11
+qbraid_cli-0.8.0.dist-info/RECORD,,

{qbraid_cli-0.7.0.dist-info → qbraid_cli-0.8.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

qbraid_cli-0.8.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+qbraid = qbraid_cli.main:app