qbraid-cli 0.9.0__tar.gz → 0.9.0a0__tar.gz

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0}/CONTRIBUTING.md

@@ -39,12 +39,6 @@ To view available `make` commands, run:
 make help
 ```
 
-To test out changes on the command line with re-installing each time:
-
-```bash
-python3 qbraid_cli/main.py [OPTIONS] COMMAND [ARGS]...
-```
-
 ## Testing
 
 Install test dependencies:

{qbraid_cli-0.9.0/qbraid_cli.egg-info → qbraid_cli-0.9.0a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.9.0
+Version: 0.9.0a0
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -29,7 +29,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typer>=0.12.1
 Requires-Dist: rich>=10.11.0
-Requires-Dist: qbraid-core>=0.1.29
+Requires-Dist: qbraid-core>=0.1.28
 Provides-Extra: jobs
 Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
 Provides-Extra: envs

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-cli"
-version = "0.9.0"
+version = "0.9.0a0"
 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" }]
@@ -30,7 +30,7 @@ classifiers = [
 dependencies = [
     "typer>=0.12.1",
     "rich>=10.11.0",
-    "qbraid-core>=0.1.29",
+    "qbraid-core>=0.1.28",
 ]
 requires-python = ">= 3.9"
 

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0}/qbraid_cli/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.1.dev1+g3ef6e9f'
-__version_tuple__ = version_tuple = (0, 1, 'dev1', 'g3ef6e9f')
+__version__ = version = '0.1.dev1+ge41229b.d20241106'
+__version_tuple__ = version_tuple = (0, 1, 'dev1', 'ge41229b.d20241106')

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0}/qbraid_cli/account/app.py

@@ -28,7 +28,7 @@ def account_credits():
 
     qbraid_credits: float = run_progress_task(get_credits)
     typer.secho(
-        f"{typer.style('qBraid credits remaining:')} "
+        f"\n{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)
     )

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0}/qbraid_cli/devices/app.py

@@ -60,7 +60,7 @@ def devices_list(  # pylint: disable=too-many-branches
     header_3 = "ID"
     header_4 = "Status"
     console.print(
-        f"[bold]{header_1.ljust(12)}{header_2.ljust(35)}{header_3.ljust(41)}{header_4}[/bold]"
+        f"\n[bold]{header_1.ljust(12)}{header_2.ljust(35)}{header_3.ljust(41)}{header_4}[/bold]"
     )
     for device_provider, device_name, device_id, device_status in device_data:
         if device_status == "ONLINE":

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0}/qbraid_cli/envs/app.py

@@ -88,7 +88,7 @@ def envs_create(  # pylint: disable=too-many-statements
     slug_path = env_path / slug
     description = "None" if description == "" else description
 
-    typer.echo("## qBraid Metadata ##\n")
+    typer.echo("\n\n## qBraid Metadata ##\n")
     typer.echo(f"  name: {display_name}")
     typer.echo(f"  description: {description}")
     typer.echo(f"  tags: {tags}")
@@ -127,7 +127,7 @@ def envs_create(  # pylint: disable=too-many-statements
 
     console = Console()
     console.print(
-        f"[bold green]Successfully created qBraid environment: "
+        f"\n[bold green]Successfully created qBraid environment: "
         f"[/bold green][bold magenta]{name}[/bold magenta]\n"
     )
     typer.echo("# To activate this environment, use")
@@ -192,7 +192,7 @@ def envs_remove(
             description="Deleting local environment...",
             error_message="Failed to delete qBraid environment",
         )
-        typer.echo(f"Environment '{name}' successfully removed.")
+        typer.echo(f"\nEnvironment '{name}' successfully removed.")
 
 
 @envs_app.command(name="list")

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0}/qbraid_cli/handlers.py

@@ -10,7 +10,6 @@ and executing operations with progress tracking within the qBraid CLI.
 import os
 import traceback
 from pathlib import Path
-from time import sleep
 from typing import Any, Callable, Optional, Union
 
 import typer
@@ -130,14 +129,11 @@ def run_progress_task(
         try:
             result = operation(*args, **kwargs)
             progress.update(task, completed=100, status="Done")
-            sleep(0.15)
             return result
         except Exception as err:  # pylint: disable=broad-exception-caught
             progress.update(task, completed=100, status="Failed")
             custom_message = error_message if error_message else str(err)
             return handle_error(message=custom_message)
-        finally:
-            progress.remove_task(task)
 
 
 def _format_list_items(items: list[str]) -> str:

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0}/qbraid_cli/jobs/app.py

@@ -120,7 +120,7 @@ def jobs_list(
         header_1 = "Job ID"
         header_2 = "Submitted"
         header_3 = "Status"
-        console.print(f"[bold]{header_1.ljust(spacing)}{header_2.ljust(36)}{header_3}[/bold]")
+        console.print(f"\n[bold]{header_1.ljust(spacing)}{header_2.ljust(36)}{header_3}[/bold]")
         for job_id, submitted, status in job_data:
             if status == "COMPLETED":
                 status_color = "green"

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0}/qbraid_cli/jobs/toggle_braket.py

@@ -103,7 +103,7 @@ def confirm_updates(
     else:
         raise ValueError(f"Invalid mode: {mode}. Expected 'enable' or 'disable'.")
 
-    typer.echo(f"==> WARNING: {provider}/{core_package} package required <==")
+    typer.echo(f"\n==> WARNING: {provider}/{core_package} package required <==")
     if (
         installed_version is not None
         and target_version is not None

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0}/qbraid_cli/main.py

@@ -6,7 +6,6 @@ Entrypoint for the qBraid CLI.
 
 """
 
-import rich
 import typer
 
 from qbraid_cli.account.app import account_app
@@ -68,7 +67,7 @@ def show_banner():
     typer.echo("")
     typer.echo("- Use 'qbraid --version' to see the current version.")
     typer.echo("")
-    rich.print("Reference Docs: https://docs.qbraid.com/cli/api-reference/qbraid")
+    typer.echo("Reference Docs: https://docs.qbraid.com/cli/api-reference/qbraid")
 
 
 @app.callback(invoke_without_command=True)

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0/qbraid_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.9.0
+Version: 0.9.0a0
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -29,7 +29,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typer>=0.12.1
 Requires-Dist: rich>=10.11.0
-Requires-Dist: qbraid-core>=0.1.29
+Requires-Dist: qbraid-core>=0.1.28
 Provides-Extra: jobs
 Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
 Provides-Extra: envs

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0}/qbraid_cli.egg-info/SOURCES.txt

@@ -11,7 +11,6 @@ pyproject.toml
 .github/ISSUE_TEMPLATE/bug_report.yml
 .github/ISSUE_TEMPLATE/feature_request.yml
 .github/workflows/bump-version.yml
-.github/workflows/docs-pr.yml
 .github/workflows/docs.yml
 .github/workflows/format.yml
 .github/workflows/main.yml
@@ -66,7 +65,6 @@ qbraid_cli/pip/__init__.py
 qbraid_cli/pip/app.py
 qbraid_cli/pip/hooks.py
 tests/__init__.py
-tests/conftest.py
 tests/account/__init__.py
 tests/account/test_account_credits.py
 tests/admin/test_headers.py

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0}/qbraid_cli.egg-info/requires.txt

@@ -1,6 +1,6 @@
 typer>=0.12.1
 rich>=10.11.0
-qbraid-core>=0.1.29
+qbraid-core>=0.1.28
 
 [dev]
 isort

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0}/tests/devices/test_devices_list.py

@@ -6,20 +6,27 @@ Unit tests for the devices_list function in the devices app.
 
 """
 
+import os
 from unittest.mock import MagicMock, patch
 
 import pytest
+from qbraid_core import QbraidSession
 from qbraid_core.services.quantum.exceptions import QuantumServiceRequestError
 from typer.testing import CliRunner
 
 from qbraid_cli.devices.app import devices_list
 
+qbraidrc_path = os.path.join(os.path.expanduser("~"), ".qbraid", "qbraidrc")
+qbraid_api_key = os.getenv("QBRAID_API_KEY")
+
 runner = CliRunner()
 
 
-@pytest.mark.remote
 def test_devices_list_no_results():
     """Test when no results are returned from the API."""
+    session = QbraidSession(api_key=qbraid_api_key)
+    session.save_config(api_key=qbraid_api_key)
+
     with (
         patch("qbraid_core.services.quantum.process_job_data", return_value=([], 0)),
         patch("rich.console.Console.print") as mock_console_print,
@@ -28,7 +35,6 @@ def test_devices_list_no_results():
         assert "No results matching given criteria" in str(mock_console_print.call_args)
 
 
-@pytest.mark.remote
 def test_quantum_client_search_devices_failure():
     """Test that QuantumClient.search_devices correctly raises an exception."""
     with patch(
@@ -38,12 +44,16 @@ def test_quantum_client_search_devices_failure():
         with pytest.raises(QuantumServiceRequestError) as exc_info:
             devices_list()
 
+        # Assert the expected exception message
         assert str(exc_info.value) == "Failed to fetch device data"
 
 
-@pytest.mark.remote
 def test_devices_list_error_handling():
     """Test error handling when an error occurs during device data retrieval."""
+    # Setup the initial session configuration
+    session = QbraidSession(api_key=qbraid_api_key)
+    session.save_config(api_key=qbraid_api_key)
+
     with (
         patch("qbraid_cli.handlers.run_progress_task", return_value=(MagicMock(), MagicMock())),
         patch(
@@ -57,9 +67,11 @@ def test_devices_list_error_handling():
         assert str(exc_info.value) == "Failed to fetch device data."
 
 
-@pytest.mark.remote
 def test_output_formatting_console():
     """Test the output formatting in the console."""
+    session = QbraidSession(api_key=qbraid_api_key)
+    session.save_config(api_key=qbraid_api_key)
+
     mock_device_data = [("AWS", "Quantum Computer", "dev_123", "ONLINE")]
 
     with (

{qbraid_cli-0.9.0 → qbraid_cli-0.9.0a0}/tests/jobs/test_jobs_list.py

@@ -6,16 +6,22 @@ Unit tests for the `jobs_list` function in the `qbraid_cli.jobs.app` module.
 
 """
 
+import os
 from unittest.mock import patch
 
-import pytest
+from qbraid_core import QbraidSession
 
 from qbraid_cli.jobs.app import jobs_list
 
+qbraidrc_path = os.path.join(os.path.expanduser("~"), ".qbraid", "qbraidrc")
+qbraid_api_key = os.getenv("QBRAID_API_KEY")
+
 
-@pytest.mark.remote
 def test_jobs_list_with_limit():
     """Test the `jobs_list` function with a limit parameter."""
+    session = QbraidSession(api_key=qbraid_api_key)
+    session.save_config(api_key=qbraid_api_key)
+
     mock_raw_data = [
         ("job_id_1", "2023-03-19 12:00", "COMPLETED"),
         ("job_id_2", "2023-03-18 11:00", "FAILED"),
@@ -35,9 +41,11 @@ def test_jobs_list_with_limit():
         ), "Console should print each job and possibly more for headers/executable."
 
 
-@pytest.mark.remote
 def test_jobs_list_output_formatting_console():
     """Test the jobs list output formatting in the console."""
+    session = QbraidSession(api_key=qbraid_api_key)
+    session.save_config(api_key=qbraid_api_key)
+
     mock_raw_data = [("job_id_1", "2023-03-19 12:00", "COMPLETED")]
     mock_message = f"Displaying {len(mock_raw_data)} most recent jobs"
     mock_job_data = (mock_raw_data, mock_message)
@@ -47,4 +55,6 @@ def test_jobs_list_output_formatting_console():
         patch("rich.console.Console.print") as mock_console_print,
     ):
         jobs_list(limit=1)
+
+        # Assuming here that if `Console.print` is called, formatting has been attempted
         mock_console_print.assert_called()

qbraid_cli-0.9.0/.github/workflows/docs-pr.yml

@@ -1,128 +0,0 @@
-name: Open Docs PR
-
-on:
-  pull_request:
-    types: [closed]
-
-jobs:
-  generate-docs-assets:
-    if: github.event.pull_request.merged == true && github.event.pull_request.user.login == 'github-actions[bot]' && startsWith(github.event.pull_request.title, 'Bump project version to ')
-    runs-on: ubuntu-latest
-    outputs:
-      cli_version: ${{ steps.get_version.outputs.version }}
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          ref: main
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip setuptools build
-          python -m pip install -r docs/requirements.txt
-
-      - name: Build & install package
-        run: |
-          make build
-          tools/install_wheel_extras.sh dist --extra envs
-
-      - name: Get qbraid-cli version
-        id: get_version
-        run: |
-          VERSION=$(qbraid --version | grep -o '[0-9]*\.[0-9]*\.[0-9]*')
-          echo "version=$VERSION" >> $GITHUB_OUTPUT
-
-      - name: Generate docs assets
-        run: |
-          make docs-mdx
-
-      - name: Upload docs assets
-        uses: actions/upload-artifact@v4
-        with:
-          name: api-reference
-          path: docs/tree/qbraid*.mdx
-
-  commit-and-pr:
-    if: github.event.pull_request.merged == true && github.event.pull_request.user.login == 'github-actions[bot]' && startsWith(github.event.pull_request.title, 'Bump project version to ')
-    runs-on: ubuntu-latest
-    needs: generate-docs-assets
-    permissions:
-      contents: write
-      pull-requests: write
-
-    steps:
-      - name: Download docs assets
-        uses: actions/download-artifact@v4
-        with:
-          name: api-reference
-          path: ./api-reference
-
-      - name: Checkout qBraid/docs repo
-        uses: actions/checkout@v4
-        with:
-          repository: qBraid/docs
-          token: ${{ secrets.BOT_TOKEN }}
-          path: ./qbraid_docs
-          ref: main
-
-      - name: Create feature branch
-        run: |
-          cd qbraid_docs
-          git checkout -b qbraid-cli-bot/${{ github.run_id }}
-
-      - name: Update docs in qBraid/docs
-        run: |
-          rm -f qbraid_docs/cli/api-reference/*
-          cp api-reference/qbraid*.mdx qbraid_docs/cli/api-reference/
-
-      - name: Inject version
-        run: |
-          VERSION=${{ needs.generate-docs-assets.outputs.cli_version }}
-          sed -i "6iVersion: [$VERSION](https://pypi.org/project/qbraid-cli/$VERSION)\n" qbraid_docs/cli/api-reference/qbraid.mdx
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '22'
-  
-      - name: Install dependencies
-        run: |
-          cd qbraid_docs
-          npm install
-
-      - name: Run prettier fixes
-        run: |
-          cd qbraid_docs
-          npx prettier --write cli/api-reference/qbraid*.mdx
-
-      - name: Setup Git config
-        run: |
-          git config --global user.name 'qbraidTeam'
-          git config --global user.email 'qbraid.team@qbraid.com'
-
-      - name: Commit and push changes
-        id: commit_and_push
-        run: |
-          cd qbraid_docs
-          git add cli/api-reference/
-          git commit -m "qBraid-CLI API reference docs update for version $VERSION"
-          git push origin qbraid-cli-bot/${{ github.run_id }}
-
-      - name: Create Pull Request
-        id: create_pr
-        run: |
-          cd qbraid_docs
-          VERSION=${{ needs.generate-docs-assets.outputs.cli_version }}
-          PR_URL=$(gh pr create -B main -H qbraid-cli-bot/${{ github.run_id }} --title "Update qBraid-CLI version $VERSION" --body "This PR updates the qBraid-CLI API reference docs for the latest release version $VERSION")
-          PR_NUMBER=$(echo "$PR_URL" | grep -o '[0-9]*$')
-          echo "url=$PR_URL" >> $GITHUB_OUTPUT
-          echo "number=$PR_NUMBER" >> $GITHUB_OUTPUT
-        env:
-          GH_TOKEN: ${{ secrets.BOT_TOKEN }}
-
-      - name: Summary
-        run: |
-          VERSION=${{ needs.generate-docs-assets.outputs.cli_version }}
-          PR_URL=${{ steps.create_pr.outputs.url }}
-          PR_NUMBER=${{ steps.create_pr.outputs.number }}
-          echo "Opened PR [#$PR_NUMBER]($PR_URL) to update CLI docs for version **$VERSION**." >> $GITHUB_STEP_SUMMARY

qbraid_cli-0.9.0/tests/conftest.py

@@ -1,35 +0,0 @@
-# Copyright (c) 2024, qBraid Development Team
-# All rights reserved.
-
-"""
-Configurations for pytest including remote test marker and command-line option.
-
-"""
-import os
-
-import pytest
-
-
-def pytest_addoption(parser):
-    """Adds custom remote testing command-line option to pytest."""
-    parser.addoption(
-        "--remote",
-        action="store",
-        default=None,
-        help="Run tests that interface with remote, credentialed services: true or false",
-    )
-
-
-def pytest_collection_modifyitems(config, items):
-    """Skip tests marked with `remote` if remote tests are disabled."""
-    remote_option = config.getoption("--remote")
-    if remote_option is None:
-        remote_option = os.getenv("QBRAID_RUN_REMOTE_TESTS", "True").lower() == "true"
-    else:
-        remote_option = remote_option.lower() == "true"
-
-    if not remote_option:
-        skip_remote = pytest.mark.skip(reason="Remote tests are disabled.")
-        for item in items:
-            if "remote" in item.keywords:
-                item.add_marker(skip_remote)