qbraid-cli 0.12.0a6__tar.gz → 0.13.0__tar.gz

{qbraid_cli-0.12.0a6 → qbraid_cli-0.13.0}/LICENSE

@@ -1,6 +1,6 @@
 qBraid Commercial Software License
 
-Copyright (c) 2025, qBraid Development Team
+Copyright (c) 2026, qBraid Development Team
 
 All rights reserved.
 

{qbraid_cli-0.12.0a6/qbraid_cli.egg-info → qbraid_cli-0.13.0}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: qbraid-cli
-Version: 0.12.0a6
+Version: 0.13.0
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License-Expression: LicenseRef-Proprietary
-Project-URL: Homepage, https://docs.qbraid.com/cli/user-guide/overview
-Project-URL: Documentation, https://docs.qbraid.com/cli/api-reference/qbraid
+Project-URL: Homepage, https://docs.qbraid.com/v2/cli/user-guide/overview
+Project-URL: Documentation, https://docs.qbraid.com/v2/cli/api-reference/qbraid
 Project-URL: Bug Tracker, https://github.com/qBraid/community/issues
 Project-URL: Discord, https://discord.gg/KugF6Cnncm
 Keywords: qbraid,cli,quantum,cloud
@@ -18,25 +18,23 @@ 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
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typer>=0.12.1
 Requires-Dist: rich>=10.11.0
-Requires-Dist: click<=8.1.8
-Requires-Dist: qbraid-core[environments]>=0.2.0a0
-Provides-Extra: jobs
-Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
+Requires-Dist: click<=8.3.3
+Requires-Dist: questionary>=2.0.0
+Requires-Dist: qbraid-core>=0.3.0
+Provides-Extra: compute
+Requires-Dist: qbraid-core[compute]>=0.3.0; extra == "compute"
 Provides-Extra: envs
-Requires-Dist: qbraid-core[environments]>=0.2.0a0; extra == "envs"
-Provides-Extra: mcp
-Requires-Dist: qbraid-core[mcp]>=0.2.0a0; extra == "mcp"
+Requires-Dist: qbraid-core[environments]>=0.3.0; extra == "envs"
 Provides-Extra: dev
 Requires-Dist: isort; extra == "dev"
 Requires-Dist: black; extra == "dev"
@@ -47,20 +45,16 @@ Dynamic: license-file
 
 <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/cli/user-guide/overview)
+[![Documentation](https://img.shields.io/badge/Documentation-DF0982)](https://docs.qbraid.com/v2/cli/user-guide/overview)
 [![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/community/issues)
-[![Stack Overflow](https://img.shields.io/badge/StackOverflow-qbraid-orange?logo=stackoverflow)](https://stackoverflow.com/questions/tagged/qbraid)
 
 Command Line Interface for interacting with all parts of the qBraid platform.
 
-The **qBraid CLI** is a versatile command-line interface tool designed for seamless interaction with qBraid cloud services and quantum software management tools. Initially exclusive to the [qBraid Lab](https://docs.qbraid.com/lab/user-guide/overview) platform, the CLI now supports local installations as well. This enhancement broadens access to features like [qBraid Quantum Jobs](https://docs.qbraid.com/cli/user-guide/quantum-jobs), enabling direct, pre-configured access to QPUs from IonQ, Oxford Quantum Circuits, QuEra, Rigetti, and IQM, as well as on-demand simulators from qBraid, AWS, IonQ, QuEra, and NEC. See [pricing](https://docs.qbraid.com/home/pricing) for more.
-
 *Resources*:
-- [User Guide](https://docs.qbraid.com/cli/user-guide/overview)
-- [API Reference](https://docs.qbraid.com/cli/api-reference/qbraid)
+- [User Guide](https://docs.qbraid.com/v2/cli/user-guide/overview)
+- [API Reference](https://docs.qbraid.com/v2/cli/api-reference/qbraid)
 
 ## Getting Started
 
@@ -69,7 +63,7 @@ The qBraid-CLI comes pre-installed and pre-configured in qBraid Lab:
 - [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/lab/user-guide/getting-started).
+For help, see qBraid Lab User Guide: [Getting Started](https://docs.qbraid.com/v2/lab/user-guide/getting-started).
 
 You can also install the qBraid-CLI from PyPI with:
 
@@ -77,7 +71,7 @@ You can also install the qBraid-CLI from PyPI with:
 pip install qbraid-cli
 ```
 
-To manage qBraid [environments](https://docs.qbraid.com/lab/user-guide/environments) using the CLI, you must also install the `envs` extra:
+To manage qBraid [environments](https://docs.qbraid.com/v2/lab/user-guide/environments) using the CLI, you must also install the `envs` extra:
 
 ```bash
 pip install 'qbraid-cli[envs]'
@@ -91,13 +85,13 @@ After installation, you must configure your account credentials to use the CLI l
    [account.qbraid.com](https://account.qbraid.com/)
 2. Copy your API Key token from the left side of
     your [account page](https://account.qbraid.com/):
-3. Save your API key from step 2 in local [configuration file](https://docs.qbraid.com/cli/user-guide/config-files) `~/.qbraid/qbraidrc` using:
+3. Save your API key from step 2 in local [configuration file](https://docs.qbraid.com/v2/cli/user-guide/config-files) `~/.qbraid/qbraidrc` using:
 
 ```bash
 $ qbraid configure
 ```
 
-For more on API keys, see [documentation](https://docs.qbraid.com/home/account#api-keys).
+For more on API keys, see [documentation](https://docs.qbraid.com/v2/home/account#api-keys).
 
 ## Basic Commands
 
@@ -119,7 +113,7 @@ $ qbraid
 
 - Use 'qbraid --version' to see the current version.
 
-Reference Docs: https://docs.qbraid.com/cli/api-reference/qbraid
+Reference Docs: https://docs.qbraid.com/v2/cli/api-reference/qbraid
 ```
 
 A qBraid CLI command has the following structure:
@@ -142,36 +136,6 @@ $ qbraid <command> --help
 $ qbraid <command> <subcommand> --help
 ```
 
-For example:
-
-```bash
-$ 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
-  account                       Manage qBraid account
-  admin                         CI/CD commands for qBraid maintainers.
-  configure                     Configure qBraid CLI options.
-  account                       Manage qBraid account.
-  chat                          Interact with qBraid AI chat service.
-  devices                       Manage qBraid quantum devices.
-  envs                          Manage qBraid environments.
-  files                         Manage qBraid cloud storage files.
-  jobs                          Manage qBraid quantum jobs.
-  kernels                       Manage qBraid kernels.
-  mcp                           MCP (Model Context Protocol) aggregator commands.
-  pip                           Run pip command in active qBraid environment.
-```
-
 To get the version of the qBraid CLI:
 
 ```bash
@@ -180,7 +144,7 @@ $ qbraid --version
 
 ## Magic Commands
 
-You can also access the CLI directly from within [Notebooks](https://docs.qbraid.com/lab/user-guide/notebooks) using IPython [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html). First, configure the qBraid magic commands extension using:
+You can also access the CLI directly from within [Notebooks](https://docs.qbraid.com/v2/lab/user-guide/notebooks) using IPython [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html). First, configure the qBraid magic commands extension using:
 
 ```bash
 $ qbraid configure magic
@@ -195,5 +159,5 @@ In [1]: %load_ext qbraid_magic
 Now you can continue to use the qBraid-CLI as normal from within your Jupyter notebook using the magic ``%`` operator, e.g.
 
 ```python
-In [2]: %qbraid chat -f code -p "Write a Qiskit bell circuit"
+In [2]: %qbraid jobs list
 ```

qbraid_cli-0.13.0/README.md

@@ -0,0 +1,118 @@
+<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/v2/cli/user-guide/overview)
+[![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/)
+[![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/qBraid/community/issues)
+
+Command Line Interface for interacting with all parts of the qBraid platform.
+
+*Resources*:
+- [User Guide](https://docs.qbraid.com/v2/cli/user-guide/overview)
+- [API Reference](https://docs.qbraid.com/v2/cli/api-reference/qbraid)
+
+## Getting Started
+
+The qBraid-CLI comes pre-installed and pre-configured in qBraid Lab:
+
+- [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/v2/lab/user-guide/getting-started).
+
+You can also install the qBraid-CLI from PyPI with:
+
+```bash
+pip install qbraid-cli
+```
+
+To manage qBraid [environments](https://docs.qbraid.com/v2/lab/user-guide/environments) using the CLI, you must also install the `envs` extra:
+
+```bash
+pip install 'qbraid-cli[envs]'
+```
+
+## Local configuration
+
+After installation, you must configure your account credentials to use the CLI locally:
+
+1. Create a qBraid account or log in to your existing account by visiting
+   [account.qbraid.com](https://account.qbraid.com/)
+2. Copy your API Key token from the left side of
+    your [account page](https://account.qbraid.com/):
+3. Save your API key from step 2 in local [configuration file](https://docs.qbraid.com/v2/cli/user-guide/config-files) `~/.qbraid/qbraidrc` using:
+
+```bash
+$ qbraid configure
+```
+
+For more on API keys, see [documentation](https://docs.qbraid.com/v2/home/account#api-keys).
+
+## Basic Commands
+
+```bash
+$ 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/v2/cli/api-reference/qbraid
+```
+
+A qBraid CLI command has the following structure:
+
+```bash
+$ qbraid <command> <subcommand> [options and parameters]
+```
+
+For example, to list installed environments, the command would be:
+
+```bash
+$ qbraid envs list
+```
+
+To view help documentation, use one of the following:
+
+```bash
+$ qbraid --help
+$ qbraid <command> --help
+$ qbraid <command> <subcommand> --help
+```
+
+To get the version of the qBraid CLI:
+
+```bash
+$ qbraid --version
+```
+
+## Magic Commands
+
+You can also access the CLI directly from within [Notebooks](https://docs.qbraid.com/v2/lab/user-guide/notebooks) using IPython [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html). First, configure the qBraid magic commands extension using:
+
+```bash
+$ qbraid configure magic
+```
+
+The above command can also be executed from within a Jupyter notebook using the ``!`` operator. Then, from within a notebook cell, load the qBraid magic IPython extension using:
+
+```python
+In [1]: %load_ext qbraid_magic
+```
+
+Now you can continue to use the qBraid-CLI as normal from within your Jupyter notebook using the magic ``%`` operator, e.g.
+
+```python
+In [2]: %qbraid jobs list
+```

{qbraid_cli-0.12.0a6 → qbraid_cli-0.13.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-cli"
-version = "0.12.0a6"
+version = "0.13.0"
 description = "Command Line Interface for interacting with all parts of the qBraid platform."
 readme = "README.md"
 authors = [{ name = "qBraid Development Team", email = "contact@qbraid.com" }]
@@ -21,7 +21,6 @@ classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
@@ -31,29 +30,29 @@ classifiers = [
 dependencies = [
     "typer>=0.12.1",
     "rich>=10.11.0",
-    "click<=8.1.8",
-    "qbraid-core[environments]>=0.2.0a0",
+    "click<=8.3.3",
+    "questionary>=2.0.0",
+    "qbraid-core>=0.3.0",
 ]
-requires-python = ">= 3.9"
+requires-python = ">= 3.10"
 
 [project.urls]
-Homepage = "https://docs.qbraid.com/cli/user-guide/overview"
-Documentation = "https://docs.qbraid.com/cli/api-reference/qbraid"
+Homepage = "https://docs.qbraid.com/v2/cli/user-guide/overview"
+Documentation = "https://docs.qbraid.com/v2/cli/api-reference/qbraid"
 "Bug Tracker" = "https://github.com/qBraid/community/issues"
 Discord = "https://discord.gg/KugF6Cnncm"
 
 [project.optional-dependencies]
-jobs = ["amazon-braket-sdk>=1.48.1"]
-envs = ["qbraid-core[environments]>=0.2.0a0"]
-mcp = ["qbraid-core[mcp]>=0.2.0a0"]
+compute = ["qbraid-core[compute]>=0.3.0"]
+envs = ["qbraid-core[environments]>=0.3.0"]
 dev = ["isort", "black", "pytest", "pytest-cov", "pytest-asyncio"]
 
 [project.scripts]
 qbraid = "qbraid_cli.main:app"
 
 [tool.black]
-line-length = 100
-target-version = ["py39", "py310", "py311", "py312", "py313"]
+line-length = 110
+target-version = ["py310", "py311", "py312", "py313"]
 
 [tool.isort]
 profile = "black"
@@ -61,11 +60,11 @@ multi_line_output = 3
 include_trailing_comma = true
 force_grid_wrap = 0
 use_parentheses = true
-line_length = 100
+line_length = 110
 
 [tool.pylint.'MESSAGES CONTROL']
-max-line-length = 100
-disable = "C0415, R0914, W0511"
+max-line-length = 110
+disable = "C0116,C0302,C0415,E1101,R0801,R0903,R0912,R0913,R0914,R0915,R0917,R1702,W0212,W0511,W0621,W0707,W0718"
 
 [tool.pylint.MASTER]
 ignore-paths = [

qbraid_cli-0.13.0/qbraid_cli/_build_info.py

@@ -0,0 +1,19 @@
+# Copyright (c) 2025, qBraid Development Team
+# All rights reserved.
+
+"""
+Build metadata — auto-generated by tools/build_wheel.py during wheel builds.
+For editable installs, this file contains placeholder values.
+"""
+
+BUILD_INFO = {
+    "version": "dev",
+    "base_version": "dev",
+    "branch": "",
+    "commit": "",
+    "commit_full": "",
+    "commit_message": "",
+    "recent_changes": [],
+    "build_date": "",
+    "dirty": True,
+}

{qbraid_cli-0.12.0a6 → qbraid_cli-0.13.0}/qbraid_cli/_version.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2025, qBraid Development Team
+# Copyright (c) 2026, qBraid Development Team
 # All rights reserved.
 
 """
@@ -15,4 +15,9 @@ except Exception:  # pylint: disable=broad-exception-caught # pragma: no cover
 
 __version_tuple__ = tuple(int(part) if part.isdigit() else part for part in __version__.split("."))
 
-__all__ = ["__version__", "__version_tuple__"]
+try:
+    from ._build_info import BUILD_INFO
+except ImportError:
+    BUILD_INFO = None  # type: ignore[assignment]
+
+__all__ = ["__version__", "__version_tuple__", "BUILD_INFO"]

{qbraid_cli-0.12.0a6 → qbraid_cli-0.13.0}/qbraid_cli/account/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024, qBraid Development Team
+# Copyright (c) 2026, qBraid Development Team
 # All rights reserved.
 
 """

qbraid_cli-0.13.0/qbraid_cli/account/app.py

@@ -0,0 +1,40 @@
+# Copyright (c) 2026, qBraid Development Team
+# All rights reserved.
+
+"""
+Module defining commands in the 'qbraid user' namespace.
+
+"""
+
+import rich
+import typer
+
+from qbraid_cli.handlers import run_progress_task
+
+account_app = typer.Typer(
+    help="Manage qBraid account.\n\nView account information and check remaining credits.",
+    no_args_is_help=True,
+)
+
+
+@account_app.command(name="credits")
+def account_credits():
+    """Get number of qBraid credits remaining."""
+
+    def get_credits() -> float:
+        from qbraid_core.client import QbraidClientV1
+
+        client = QbraidClientV1()
+        return client.user_credits_value()
+
+    qbraid_credits: float = run_progress_task(get_credits)
+    typer.secho(
+        f"{typer.style('qBraid credits remaining:')} "
+        f"{typer.style(f'{qbraid_credits:.4f}', fg=typer.colors.MAGENTA, bold=True)}",
+        nl=True,  # Ensure a newline after output (default is True)
+    )
+    rich.print("\nFor more information, visit: https://docs.qbraid.com/v2/home/pricing#credits")
+
+
+if __name__ == "__main__":
+    account_app()

{qbraid_cli-0.12.0a6 → qbraid_cli-0.13.0}/qbraid_cli/admin/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024, qBraid Development Team
+# Copyright (c) 2026, qBraid Development Team
 # All rights reserved.
 
 """

{qbraid_cli-0.12.0a6 → qbraid_cli-0.13.0}/qbraid_cli/admin/app.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024, qBraid Development Team
+# Copyright (c) 2026, qBraid Development Team
 # All rights reserved.
 
 """
@@ -25,12 +25,8 @@ def admin_headers(
     src_paths: list[str] = typer.Argument(
         ..., help="Source file or directory paths to verify.", callback=validate_paths_exist
     ),
-    header_type: HeaderType = typer.Option(
-        "default", "--type", "-t", help="Type of header to use."
-    ),
-    skip_files: list[str] = typer.Option(
-        [], "--skip", "-s", help="Files to skip during verification."
-    ),
+    header_type: HeaderType = typer.Option("default", "--type", "-t", help="Type of header to use."),
+    skip_files: list[str] = typer.Option([], "--skip", "-s", help="Files to skip during verification."),
     fix: bool = typer.Option(
         False, "--fix", "-f", help="Whether to fix the headers instead of just verifying."
     ),
@@ -38,9 +34,9 @@ def admin_headers(
         None, "--project", "-p", help="Name of the project to use in the header."
     ),
 ):
-    """
-    Verifies and optionally fixes qBraid headers in specified files and directories.
+    """Verify and fix qBraid file headers.
 
+    Verifies and optionally fixes qBraid headers in specified files and directories.
     """
     check_and_fix_headers(
         src_paths,

{qbraid_cli-0.12.0a6 → qbraid_cli-0.13.0}/qbraid_cli/admin/headers.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024, qBraid Development Team
+# Copyright (c) 2026, qBraid Development Team
 # All rights reserved.
 
 # pylint: disable=too-many-branches,too-many-statements
@@ -117,6 +117,7 @@ def get_formatted_header(header_type: HeaderType, project_name: Optional[str] =
     if header_type == HeaderType.gpl:
         if project_name is None:
             handle_error("ValueError", "Project name is required for GPL header")
+            return header
 
         if project_name.split(" ")[0].lower() == "the":
             project_name = project_name[:1].lower() + project_name[1:]
@@ -131,7 +132,7 @@ def get_formatted_header(header_type: HeaderType, project_name: Optional[str] =
     return header
 
 
-def _get_comment_marker(file_path: str, default: Optional[str] = None) -> str:
+def _get_comment_marker(file_path: str, default: str | None = None) -> str | None:
     file_ext = Path(file_path).suffix
     return COMMENT_MARKER.get(file_ext, default)
 
@@ -191,6 +192,8 @@ def check_and_fix_headers(
             content = f.read()
 
         comment_marker = _get_comment_marker(file_path)
+        if comment_marker is None:
+            return
 
         # This finds the start of the actual content after skipping initial whitespace and comments.
         lines = content.splitlines()
@@ -246,9 +249,7 @@ def check_and_fix_headers(
             checked += 1
         else:
             if not os.path.isfile(item):
-                handle_error(
-                    error_type="FileNotFoundError", message=f"Path '{item}' does not exist."
-                )
+                handle_error(error_type="FileNotFoundError", message=f"Path '{item}' does not exist.")
 
     if checked == 0:
         console.print(f"[bold]No {VALID_EXTS} files present. Nothing to do[/bold] 😴")

{qbraid_cli-0.12.0a6 → qbraid_cli-0.13.0}/qbraid_cli/admin/validation.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2024, qBraid Development Team
+# Copyright (c) 2026, qBraid Development Team
 # All rights reserved.
 
 """

qbraid_cli-0.13.0/qbraid_cli/agents/__init__.py

@@ -0,0 +1,8 @@
+# Copyright (c) 2026, qBraid Development Team
+# All rights reserved.
+
+"""Agents CLI subcommand."""
+
+from .app import agents_app
+
+__all__ = ["agents_app"]