qbraid-cli 0.8.5a1__py3-none-any.whl → 0.12.0a0__py3-none-any.whl

qbraid_cli/_version.py

@@ -1,16 +1,18 @@
-# file generated by setuptools_scm
-# don't change, don't track in version control
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple, Union
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-else:
-    VERSION_TUPLE = object
+# Copyright (c) 2025, qBraid Development Team
+# All rights reserved.
 
-version: str
-__version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
+"""
+Module defining package version.
 
-__version__ = version = '0.8.5a1'
-__version_tuple__ = version_tuple = (0, 8, 5)
+"""
+
+import importlib.metadata
+
+try:
+    __version__ = importlib.metadata.version("qbraid-cli")
+except Exception:  # pylint: disable=broad-exception-caught # pragma: no cover
+    __version__ = "dev"
+
+__version_tuple__ = tuple(int(part) if part.isdigit() else part for part in __version__.split("."))
+
+__all__ = ["__version__", "__version_tuple__"]

qbraid_cli/account/__init__.py

@@ -0,0 +1,11 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module defining the qbraid account namespace
+
+"""
+
+from .app import account_app
+
+__all__ = ["account_app"]

qbraid_cli/account/app.py

@@ -0,0 +1,67 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module defining commands in the 'qbraid user' namespace.
+
+"""
+
+from typing import Any
+
+import rich
+import typer
+
+from qbraid_cli.configure.actions import QBRAID_ORG_MODEL_ENABLED
+from qbraid_cli.handlers import run_progress_task
+
+account_app = typer.Typer(help="Manage qBraid account.", 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 import QbraidClient
+
+        client = QbraidClient()
+        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/home/pricing#credits")
+
+
+@account_app.command(name="info")
+def account_info():
+    """Get qBraid account (user) metadata."""
+
+    def get_user() -> dict[str, Any]:
+        from qbraid_core import QbraidSession
+
+        session = QbraidSession()
+        user = session.get_user()
+        personal_info: dict = user.get("personalInformation", {})
+        metadata = {
+            "_id": user.get("_id"),
+            "userName": user.get("userName"),
+            "email": user.get("email"),
+            "joinedDate": user.get("createdAt", "Unknown"),
+            "activePlan": user.get("activePlan", "") or "Free",
+            "role": personal_info.get("role", "") or "guest",
+        }
+        if QBRAID_ORG_MODEL_ENABLED:
+            metadata["organization"] = personal_info.get("organization", "") or "qbraid"
+
+        return metadata
+
+    info = run_progress_task(get_user)
+    rich.print(info)
+
+
+if __name__ == "__main__":
+    account_app()

qbraid_cli/admin/app.py

@@ -5,16 +5,19 @@
 Module defining commands in the 'qbraid admin' namespace.
 
 """
+
+from typing import Optional
+
 import typer
 
-from qbraid_cli.admin.buildlogs import buildlogs_app
-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.", pretty_exceptions_show_locals=False
+    help="CI/CD commands for qBraid maintainers.",
+    pretty_exceptions_show_locals=False,
+    no_args_is_help=True,
 )
-admin_app.add_typer(buildlogs_app, name="buildlogs")
 
 
 @admin_app.command(name="headers")
@@ -22,25 +25,30 @@ 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
+        [], "--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."
     ),
+    project_name: Optional[str] = typer.Option(
+        None, "--project", "-p", help="Name of the project to use in the header."
+    ),
 ):
     """
     Verifies and optionally fixes qBraid headers in specified files and directories.
 
     """
-    check_and_fix_headers(src_paths, header_type=header_type, skip_files=skip_files, fix=fix)
+    check_and_fix_headers(
+        src_paths,
+        header_type=header_type,
+        skip_files=skip_files,
+        fix=fix,
+        project_name=project_name,
+    )
 
 
 if __name__ == "__main__":

qbraid_cli/admin/headers.py

@@ -1,11 +1,18 @@
 # Copyright (c) 2024, qBraid Development Team
 # All rights reserved.
 
+# pylint: disable=too-many-branches,too-many-statements
+
 """
 Script to verify qBraid copyright file headers
 
 """
+
+import datetime
 import os
+import warnings
+from enum import Enum
+from pathlib import Path
 from typing import Optional
 
 import typer
@@ -13,51 +20,144 @@ 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
+
+COMMENT_MARKER = {
+    ".py": "#",
+    ".js": "//",
+    ".ts": "//",
+}
+
+VALID_EXTS = tuple(COMMENT_MARKER.keys())
+
+
+class HeaderType(Enum):
+    """Type of header to use."""
 
-DEFAULT_HEADER = """# Copyright (c) 2024, qBraid Development Team
+    default = "default"  # pylint: disable=invalid-name
+    gpl = "gpl"  # pylint: disable=invalid-name
+    apache = "apache"  # pylint: disable=invalid-name
+    mit = "mit"  # pylint: disable=invalid-name
+
+
+DEFAULT_HEADER = f"""# Copyright (c) {CURR_YEAR}, qBraid Development Team
 # All rights reserved.
 """
 
-DEFAULT_HEADER_GPL = """# Copyright (C) 2024 qBraid
+DEFAULT_HEADER_GPL = f"""# Copyright (C) {CURR_YEAR} qBraid
 #
-# This file is part of the qBraid-SDK
+# This file is part of {{project_name}}
 #
-# The qBraid-SDK 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 the qBraid-SDK, as per Section 15 of the GPL v3.
+# THERE IS NO WARRANTY for {{project_name}}, as per Section 15 of the GPL v3.
+"""
+
+DEFAULT_HEADER_APACHE = f"""# Copyright {CURR_YEAR} qBraid
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""
+
+DEFAULT_HEADER_MIT = f"""# MIT License
+#
+# Copyright (c) {CURR_YEAR} qBraid
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
 """
 
 HEADER_TYPES = {
-    "default": DEFAULT_HEADER,
-    "gpl": DEFAULT_HEADER_GPL,
+    HeaderType.default: DEFAULT_HEADER,
+    HeaderType.gpl: DEFAULT_HEADER_GPL,
+    HeaderType.apache: DEFAULT_HEADER_APACHE,
+    HeaderType.mit: DEFAULT_HEADER_MIT,
 }
 
 
+def get_formatted_header(header_type: HeaderType, project_name: Optional[str] = None) -> str:
+    """Get the formatted header based on the header type
+
+    Args:
+        header_type (str): The type of header to use.
+        project_name (str): The name of the project to use in the header.
+
+    Returns:
+        str: The formatted header
+    """
+
+    header = HEADER_TYPES[header_type]
+    if header_type == HeaderType.gpl:
+        if project_name is None:
+            handle_error("ValueError", "Project name is required for GPL header")
+
+        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)
+
+    if project_name is not None:
+        warnings.warn(f"\nProject name is not used for header type '{header_type}'.", UserWarning)
+
+    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,
 ) -> None:
     """Script to add or verify qBraid copyright file headers"""
     try:
-        header = HEADER_TYPES[header_type]
+        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:
         if not os.path.exists(path):
             handle_error(error_type="FileNotFoundError", message=f"Path '{path}' does not exist.")
 
-    header_2023 = header.replace("2024", "2023")
+    header_prev_year = header.replace(str(CURR_YEAR), str(PREV_YEAR))
 
     skip_files = skip_files or []
 
@@ -73,7 +173,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():
@@ -89,10 +190,12 @@ def check_and_fix_headers(
         with open(file_path, "r", encoding="ISO-8859-1") as f:
             content = f.read()
 
+        comment_marker = _get_comment_marker(file_path)
+
         # This finds the start of the actual content after skipping initial whitespace and comments.
         lines = content.splitlines()
         first_non_comment_line_index = next(
-            (i for i, line in enumerate(lines) if not line.strip().startswith("#")), None
+            (i for i, line in enumerate(lines) if not line.strip().startswith(comment_marker)), None
         )
 
         # Prepare the content by stripping leading and trailing whitespace and separating into lines
@@ -102,10 +205,13 @@ def check_and_fix_headers(
             else ""
         )
 
+        updated_header = header.replace("#", comment_marker)
+        updated_prev_header = header_prev_year.replace("#", comment_marker)
+
         # Check if the content already starts with the header or if the file should be skipped
         if (
-            content.lstrip().startswith(header)
-            or content.lstrip().startswith(header_2023)
+            content.lstrip().startswith(updated_header)
+            or content.lstrip().startswith(updated_prev_header)
             or should_skip(file_path, content)
         ):
             return
@@ -114,7 +220,7 @@ def check_and_fix_headers(
             failed_headers.append(file_path)
         else:
             # Form the new content by combining the header, one blank line, and the actual content
-            new_content = header.strip() + "\n\n" + actual_content
+            new_content = updated_header.strip() + "\n\n" + actual_content + "\n"
             with open(file_path, "w", encoding="ISO-8859-1") as f:
                 f.write(new_content)
             fixed_headers.append(file_path)
@@ -125,7 +231,7 @@ def check_and_fix_headers(
             return count
         for root, _, files in os.walk(directory):
             for file in files:
-                if file.endswith(".py"):
+                if file.endswith(VALID_EXTS):
                     file_path = os.path.join(root, file)
                     replace_or_add_header(file_path, fix)
                     count += 1
@@ -135,14 +241,17 @@ def check_and_fix_headers(
     for item in src_paths:
         if os.path.isdir(item):
             checked += process_files_in_directory(item, fix)
-        elif os.path.isfile(item) and item.endswith(".py"):
+        elif os.path.isfile(item) and item.endswith(VALID_EXTS):
             replace_or_add_header(item, fix)
             checked += 1
         else:
-            handle_error(error_type="FileNotFoundError", message=f"Path '{item}' does not exist.")
+            if not os.path.isfile(item):
+                handle_error(
+                    error_type="FileNotFoundError", message=f"Path '{item}' does not exist."
+                )
 
     if checked == 0:
-        console.print("[bold]No Python files present. Nothing to do[/bold] 😴")
+        console.print(f"[bold]No {VALID_EXTS} files present. Nothing to do[/bold] 😴")
         raise typer.Exit(0)
 
     if not fix:

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/chat/__init__.py

@@ -0,0 +1,11 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module defining the qbraid chat namespace
+
+"""
+
+from .app import ChatFormat, list_models_callback, prompt_callback
+
+__all__ = ["list_models_callback", "prompt_callback", "ChatFormat"]

qbraid_cli/chat/app.py

@@ -0,0 +1,76 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module defining commands in the 'qbraid chat' namespace.
+
+"""
+from enum import Enum
+
+from rich.console import Console
+from rich.table import Table
+
+from qbraid_cli.handlers import handle_error, run_progress_task
+
+
+class ChatFormat(str, Enum):
+    """Format of the response from the chat service."""
+
+    text = "text"  # pylint: disable=invalid-name
+    code = "code"  # pylint: disable=invalid-name
+
+
+def list_models_callback():
+    """List available chat models."""
+    # pylint: disable-next=import-outside-toplevel
+    from qbraid_core.services.chat import ChatClient
+
+    client = ChatClient()
+
+    models = run_progress_task(
+        client.get_models,
+        description="Connecting to chat service...",
+        include_error_traceback=False,
+    )
+
+    console = Console()
+    table = Table(title="Available Chat Models\n", show_lines=True, title_justify="left")
+
+    table.add_column("Model", style="cyan", no_wrap=True)
+    table.add_column("Pricing [not bold](1k tokens ~750 words)", style="magenta")
+    table.add_column("Description", style="green")
+
+    for model in models:
+        table.add_row(
+            model["model"],
+            f"{model['pricing']['input']} credits / 1M input tokens\n"
+            f"{model['pricing']['output']} credits / 1M output tokens",
+            model["description"],
+        )
+
+    console.print(table)
+
+
+def prompt_callback(prompt: str, model: str, response_format: ChatFormat, stream: bool):
+    """Send a chat prompt to the chat service."""
+    # pylint: disable-next=import-outside-toplevel
+    from qbraid_core.services.chat import ChatClient, ChatServiceRequestError
+
+    client = ChatClient()
+
+    if stream:
+        try:
+            for chunk in client.chat_stream(prompt, model, response_format):
+                print(chunk, end="")
+        except ChatServiceRequestError as err:
+            handle_error(message=str(err), include_traceback=False)
+    else:
+        content = run_progress_task(
+            client.chat,
+            prompt,
+            model,
+            response_format,
+            description="Connecting to chat service...",
+            include_error_traceback=False,
+        )
+        print(content)

qbraid_cli/configure/actions.py

@@ -15,6 +15,8 @@ import typer
 from qbraid_core.config import (
     DEFAULT_CONFIG_SECTION,
     DEFAULT_ENDPOINT_URL,
+    DEFAULT_ORGANIZATION,
+    DEFAULT_WORKSPACE,
     USER_CONFIG_PATH,
     load_config,
     save_config,
@@ -23,6 +25,8 @@ from rich.console import Console
 
 from qbraid_cli.handlers import handle_filesystem_operation
 
+QBRAID_ORG_MODEL_ENABLED = False  # Set to True if organization/workspace model is enabled
+
 
 def validate_input(key: str, value: str) -> str:
     """Validate the user input based on the key.
@@ -37,6 +41,8 @@ def validate_input(key: str, value: str) -> str:
     Raises:
         typer.BadParameter: If the value is invalid
     """
+    value = value.strip()
+
     if key == "url":
         if not re.match(r"^https?://\S+$", value):
             raise typer.BadParameter("Invalid URL format.")
@@ -44,7 +50,7 @@ def validate_input(key: str, value: str) -> str:
         if not re.match(r"^\S+@\S+\.\S+$", value):
             raise typer.BadParameter("Invalid email format.")
     elif key == "api-key":
-        if not re.match(r"^[a-zA-Z0-9]{11}$", value):
+        if not re.match(r"^[a-zA-Z0-9]+$", value):
             raise typer.BadParameter("Invalid API key format.")
     return value
 
@@ -90,11 +96,24 @@ def default_action(section: str = DEFAULT_CONFIG_SECTION):
     if section not in config:
         config[section] = {}
 
-    default_values = {"url": DEFAULT_ENDPOINT_URL}
+    default_values = {
+        "url": DEFAULT_ENDPOINT_URL,
+    }
+    if QBRAID_ORG_MODEL_ENABLED:
+        default_values["organization"] = DEFAULT_ORGANIZATION
+        default_values["workspace"] = DEFAULT_WORKSPACE
 
     config[section]["url"] = prompt_for_config(config, section, "url", default_values)
     config[section]["api-key"] = prompt_for_config(config, section, "api-key", default_values)
 
+    if QBRAID_ORG_MODEL_ENABLED:
+        config[section]["organization"] = prompt_for_config(
+            config, section, "organization", default_values
+        )
+        config[section]["workspace"] = prompt_for_config(
+            config, section, "workspace", default_values
+        )
+
     for key in list(config[section]):
         if not config[section][key]:
             del config[section][key]