qbraid-cli 0.9.6__py3-none-any.whl → 0.9.7__py3-none-any.whl

qbraid_cli/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.9.6'
-__version_tuple__ = version_tuple = (0, 9, 6)
+__version__ = version = '0.9.7'
+__version_tuple__ = version_tuple = (0, 9, 7)

qbraid_cli/admin/app.py

@@ -10,8 +10,8 @@ from typing import Optional
 
 import typer
 
-from qbraid_cli.admin.headers import check_and_fix_headers
-from qbraid_cli.admin.validation import validate_header_type, validate_paths_exist
+from qbraid_cli.admin.headers import HeaderType, check_and_fix_headers
+from qbraid_cli.admin.validation import validate_paths_exist
 
 admin_app = typer.Typer(
     help="CI/CD commands for qBraid maintainers.",
@@ -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: str = typer.Option(
-        "default",
-        "--type",
-        "-t",
-        help="Type of header to use ('default' or 'gpl').",
-        callback=validate_header_type,
+    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.", callback=validate_paths_exist

qbraid_cli/admin/headers.py

@@ -1,6 +1,8 @@
 # Copyright (c) 2024, qBraid Development Team
 # All rights reserved.
 
+# pylint: disable=too-many-branches,too-many-statements
+
 """
 Script to verify qBraid copyright file headers
 
@@ -8,6 +10,8 @@ Script to verify qBraid copyright file headers
 
 import datetime
 import os
+from enum import Enum
+from pathlib import Path
 from typing import Optional
 
 import typer
@@ -15,36 +19,47 @@ from rich.console import Console
 
 from qbraid_cli.handlers import handle_error
 
-# pylint: disable=too-many-branches,too-many-statements
 CURR_YEAR = datetime.datetime.now().year
 PREV_YEAR = CURR_YEAR - 1
-VALID_EXTS = (".py", ".js", ".ts")
 
+COMMENT_MARKER = {
+    ".py": "#",
+    ".js": "//",
+    ".ts": "//",
+}
+
+VALID_EXTS = tuple(COMMENT_MARKER.keys())
+
+
+class HeaderType(Enum):
+    """Type of header to use."""
+
+    default = "default"  # pylint: disable=invalid-name
+    gpl = "gpl"  # pylint: disable=invalid-name
 
-DEFAULT_HEADER = f"""# Copyright (c) {str(CURR_YEAR)}, qBraid Development Team
+
+DEFAULT_HEADER = f"""# Copyright (c) {CURR_YEAR}, qBraid Development Team
 # All rights reserved.
 """
 
-DEFAULT_HEADER_GPL = (
-    f"""# Copyright (C) {str(CURR_YEAR)} qBraid"""
-    + """#
-# This file is part of {project_name}
+DEFAULT_HEADER_GPL = f"""# Copyright (C) {CURR_YEAR} qBraid
+#
+# This file is part of {{project_name}}
 #
-# {project_name_start} is free software released under the GNU General Public License v3
+# {{project_name_start}} is free software released under the GNU General Public License v3
 # or later. You can redistribute and/or modify it under the terms of the GPL v3.
 # See the LICENSE file in the project root or <https://www.gnu.org/licenses/gpl-3.0.html>.
 #
-# THERE IS NO WARRANTY for {project_name}, as per Section 15 of the GPL v3.
+# THERE IS NO WARRANTY for {{project_name}}, as per Section 15 of the GPL v3.
 """
-)
 
 HEADER_TYPES = {
-    "default": DEFAULT_HEADER,
-    "gpl": DEFAULT_HEADER_GPL,
+    HeaderType.default: DEFAULT_HEADER,
+    HeaderType.gpl: DEFAULT_HEADER_GPL,
 }
 
 
-def get_formatted_header(header_type: str, project_name: str) -> str:
+def get_formatted_header(header_type: HeaderType, project_name: str) -> str:
     """Get the formatted header based on the header type
 
     Args:
@@ -56,16 +71,24 @@ def get_formatted_header(header_type: str, project_name: str) -> str:
     """
 
     header = HEADER_TYPES[header_type]
-    if header_type == "gpl":
-        return header.format(
-            project_name=project_name, project_name_start=project_name[0].upper() + project_name[1:]
-        )
+    if header_type == HeaderType.gpl:
+        if project_name.split(" ")[0].lower() == "the":
+            project_name = project_name[:1].lower() + project_name[1:]
+            project_name_start = project_name[:1].upper() + project_name[1:]
+        else:
+            project_name_start = project_name
+        return header.format(project_name=project_name, project_name_start=project_name_start)
     return header
 
 
+def _get_comment_marker(file_path: str, default: Optional[str] = None) -> str:
+    file_ext = Path(file_path).suffix
+    return COMMENT_MARKER.get(file_ext, default)
+
+
 def check_and_fix_headers(
     src_paths: list[str],
-    header_type: str = "default",
+    header_type: HeaderType = HeaderType.default,
     skip_files: Optional[list[str]] = None,
     fix: bool = False,
     project_name: Optional[str] = None,
@@ -74,11 +97,10 @@ def check_and_fix_headers(
     try:
         header = get_formatted_header(header_type, project_name)
     except KeyError:
+        members = HeaderType._member_names_  # pylint: disable=no-member,protected-access
         handle_error(
             error_type="ValueError",
-            message=(
-                f"Invalid header type: {HEADER_TYPES}. Expected one of {list(HEADER_TYPES.keys())}"
-            ),
+            message=(f"Invalid header type: {HEADER_TYPES}. Expected one of {members}"),
         )
 
     for path in src_paths:
@@ -101,7 +123,8 @@ def check_and_fix_headers(
         if os.path.basename(file_path) == "__init__.py":
             return not content.strip()
 
-        skip_header_tag = "# qbraid: skip-header"
+        comment_marker = _get_comment_marker(file_path)
+        skip_header_tag = f"{comment_marker} qbraid: skip-header"
         line_number = 0
 
         for line in content.splitlines():
@@ -117,13 +140,7 @@ def check_and_fix_headers(
         with open(file_path, "r", encoding="ISO-8859-1") as f:
             content = f.read()
 
-        # Get the file extension
-        file_ext = os.path.splitext(file_path)[1]
-
-        if file_ext == ".py":
-            comment_marker = "#"
-        elif file_ext in (".js", ".ts"):
-            comment_marker = "//"
+        comment_marker = _get_comment_marker(file_path)
 
         # This finds the start of the actual content after skipping initial whitespace and comments.
         lines = content.splitlines()

qbraid_cli/admin/validation.py

@@ -10,14 +10,7 @@ import os
 
 import typer
 
-from qbraid_cli.admin.headers import HEADER_TYPES
-from qbraid_cli.handlers import _format_list_items, validate_item
-
-
-def validate_header_type(value: str) -> str:
-    """Validate header type."""
-    header_types = list(HEADER_TYPES.keys())
-    return validate_item(value, header_types, "Header type")
+from qbraid_cli.handlers import _format_list_items
 
 
 def validate_paths_exist(paths: list[str]) -> list[str]:

qbraid_cli/configure/app.py

@@ -79,7 +79,7 @@ def configure_get(
 
 @configure_app.command(name="list")
 def configure_list():
-    """List all configuration values in the default profile."""
+    """List all configuration values in qbraidrc."""
     # pylint: disable-next=import-outside-toplevel
     from qbraid_core.config import load_config
 

{qbraid_cli-0.9.6.dist-info → qbraid_cli-0.9.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: qbraid-cli
-Version: 0.9.6
+Version: 0.9.7
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -52,7 +52,11 @@ Requires-Dist: pytest-cov; extra == "dev"
 
 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 acess to QPU devices from leading providers like IonQ, Oxford Quantum Circuits, QuEra, Rigetti, and IQM, as well as on-demand simulators from qBraid and AWS, all using qBraid [credits](https://docs.qbraid.com/home/pricing), with no additional access keys required.
+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)
 
 ## Getting Started
 
@@ -69,6 +73,12 @@ 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:
+
+```bash
+pip install 'qbraid-cli[envs]'
+```
+
 ## Local configuration
 
 After installation, you must configure your account credentials to use the CLI locally:
@@ -83,6 +93,8 @@ After installation, you must configure your account credentials to use the CLI l
 $ qbraid configure
 ```
 
+For more on API keys, see [documentation](https://docs.qbraid.com/home/account#api-keys).
+
 ## Basic Commands
 
 ```bash
@@ -142,12 +154,17 @@ Options
   --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.
+  pip                           Run pip command in active qBraid environment.
 ```
 
 To get the version of the qBraid CLI:
@@ -173,7 +190,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 jobs state
-
-In [3]: %qbraid jobs enable braket -y
+In [2]: %qbraid chat -f code -p "Write a Qiskit bell circuit"
 ```

{qbraid_cli-0.9.6.dist-info → qbraid_cli-0.9.7.dist-info}/RECORD

@@ -1,5 +1,5 @@
 qbraid_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-qbraid_cli/_version.py,sha256=11ciOFzse5i9Y6lr7kosD6U2UdIm5Bsf7hdpK0Hg_2I,411
+qbraid_cli/_version.py,sha256=4XC29QIe8f6Nj4TIXVcWdhsy0tKD5guALT5XGZC9sso,411
 qbraid_cli/exceptions.py,sha256=KjlhYJhSHMVazaNiBjD_Ur06w4sekP8zRsFzBdyIpno,672
 qbraid_cli/handlers.py,sha256=B9H1Qw6yx8izrqp9OGR2TgSJa_mxA8KLXUkX8LB7Feg,7650
 qbraid_cli/main.py,sha256=aSOQyoRRvKBJBcx8VtU4zKZ2WHvGKHhw8I-WiRwPxcE,3926
@@ -7,14 +7,14 @@ qbraid_cli/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 qbraid_cli/account/__init__.py,sha256=smlpUcVkM3QEbJG0norGM7i71XBJlUGQYByswTfPnmg,181
 qbraid_cli/account/app.py,sha256=1UogauwgX0Hnr7H6cBV2Qv-lT6aRpRLAimCyLi0afGI,1843
 qbraid_cli/admin/__init__.py,sha256=qcWD5mQEUCtr49mrUpZmk7eGDe0L_Gtc8RwZmzIXSwo,175
-qbraid_cli/admin/app.py,sha256=V2mgts3x3Vgsx_nbRwVrKF9PgZ9SuA10b8O9cjiphYE,1607
-qbraid_cli/admin/headers.py,sha256=OCZ690_rjJy8ppH4ogHjiQwHWJTcPnJT0KyIT0h6hkE,7732
-qbraid_cli/admin/validation.py,sha256=U_8RFWBwRUNPe6LdjNpl-Yz8Br57PLWMoPbpR-jBS-M,979
+qbraid_cli/admin/app.py,sha256=YOVLUjKysUcvnhJF2HAhVHVKDNUJeZ-uMV81uQdzxkk,1519
+qbraid_cli/admin/headers.py,sha256=kbrJTMf0JuO5yjZGiVwFhMhrzyAfLEeCXclMHwBcT68,8384
+qbraid_cli/admin/validation.py,sha256=fhpttxupCGBk56ExQPuuQm8nMnptLLy_8sj-EjpM8g0,729
 qbraid_cli/chat/__init__.py,sha256=NO41vndEdfr0vDynNcmHFh-nhzWjnWqGm4M9parikck,258
 qbraid_cli/chat/app.py,sha256=-YqCLGDh4ezF149xB3dfuUAQotKAklZwYp0BL3HhA90,2256
 qbraid_cli/configure/__init__.py,sha256=YaJ74Ztz2vl3eYp8_jVBucWkXscxz7EZEIzr70OfuOM,187
 qbraid_cli/configure/actions.py,sha256=-BduRmnxvf8JMNonb6VWFtdlHlcHPOPz3Bj5g8kfmBU,3197
-qbraid_cli/configure/app.py,sha256=wNKOXi5GIuvVdp1G00IuOXVGvi-PpB31yaOu1bjinWQ,4175
+qbraid_cli/configure/app.py,sha256=7UN8Bje0n_s2nDE-cHid8VwOp7gl0jjw9gldyCcZNhI,4164
 qbraid_cli/devices/__init__.py,sha256=hiScO-px6jCL5cJj5Hbty55EUfNejTO4bmqUZuS3aqc,181
 qbraid_cli/devices/app.py,sha256=q8AQ8o05JXODsaFR_16_S3UtLWPzwC2qi0bVw2h7RJ8,2543
 qbraid_cli/devices/validation.py,sha256=YhShyUufgrKnx2XjXOXF-PqFJYklJT9CgeqIwKcNam4,809
@@ -34,9 +34,9 @@ qbraid_cli/kernels/app.py,sha256=n-iyWJHy7_ML6qk4pp-v_rQkGA7WfnZMG8gyiCFGO1c,294
 qbraid_cli/pip/__init__.py,sha256=tJtU0rxn-ODogNh5Y4pp_BgDQXMN-3JY1QGj0OZHwjQ,169
 qbraid_cli/pip/app.py,sha256=jkk-djductrDOJIRYfHK_7WDJ12f0zOT3MMkiZp97oM,1365
 qbraid_cli/pip/hooks.py,sha256=jkIeev3cOd-cmaoJSdSqbmhTYCs6z1we84FMqa3ZoZw,2124
-qbraid_cli-0.9.6.dist-info/LICENSE,sha256=P1gi-ofB8lmkRt_mxDoJpcgQq9Ckq9WhRAS1oYk-G1s,2506
-qbraid_cli-0.9.6.dist-info/METADATA,sha256=mlBLxNdmCCn-tU2KGErGI1JRcH5mM1A7Q_ZL8Ru8O20,6806
-qbraid_cli-0.9.6.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-qbraid_cli-0.9.6.dist-info/entry_points.txt,sha256=c5ZJ7NjbxhDqMpou9q5F03_b_KG34HzFDijIDmEIwgQ,47
-qbraid_cli-0.9.6.dist-info/top_level.txt,sha256=LTYJgeYSCHo9Il8vZu0yIPuGdGyNaIw6iRy6BeoZo8o,11
-qbraid_cli-0.9.6.dist-info/RECORD,,
+qbraid_cli-0.9.7.dist-info/LICENSE,sha256=P1gi-ofB8lmkRt_mxDoJpcgQq9Ckq9WhRAS1oYk-G1s,2506
+qbraid_cli-0.9.7.dist-info/METADATA,sha256=rTuY3_2Gy__wGEEO0vM9kDZSWSpUVnFt-GIGpi7RZCg,7525
+qbraid_cli-0.9.7.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+qbraid_cli-0.9.7.dist-info/entry_points.txt,sha256=c5ZJ7NjbxhDqMpou9q5F03_b_KG34HzFDijIDmEIwgQ,47
+qbraid_cli-0.9.7.dist-info/top_level.txt,sha256=LTYJgeYSCHo9Il8vZu0yIPuGdGyNaIw6iRy6BeoZo8o,11
+qbraid_cli-0.9.7.dist-info/RECORD,,