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

{qbraid_cli-0.8.1 → qbraid_cli-0.8.1a0}/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,3 @@
 <!-- Please link or tag any issues that is PR closes -->
 
-# Changes
+## Changes

{qbraid_cli-0.8.1 → qbraid_cli-0.8.1a0}/.github/workflows/docs.yml

@@ -21,11 +21,11 @@ jobs:
     - 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: |
         python -m build .
         python -m pip install dist/*.whl
+        tools/install_wheel_extras.sh dist --extra docs
     - name: Generate docs assets
       run: |
         python -c "import pathlib; pathlib.Path('docs/tree').mkdir(parents=True, exist_ok=True)"

{qbraid_cli-0.8.1 → qbraid_cli-0.8.1a0}/.github/workflows/main.yml

@@ -64,21 +64,9 @@ jobs:
         shell: pwsh
       - name: Install testing dependencies
         run: |
-          pip install pytest coverage
+          pip install pytest
       - name: Run tests with pytest
         run: |
-          coverage run -m pytest -x tests
-          coverage combine
-          coverage report
-          coverage html
-          coverage xml
+          pytest
         env:
-          QBRAID_API_KEY: ${{ secrets.QBRAID_API_KEY }}
-      - name: Upload coverage to Codecov
-        if: matrix.python-version == '3.11' && matrix.os == 'ubuntu-latest'
-        uses: codecov/codecov-action@v3
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          fail_ci_if_error: false
-          files: ./build/coverage/coverage.xml
-          verbose: true
+          QBRAID_API_KEY: ${{ secrets.QBRAID_API_KEY }}

{qbraid_cli-0.8.1 → qbraid_cli-0.8.1a0}/.readthedocs.yml

@@ -10,10 +10,9 @@ build:
   tools:
     python: "3.10"
   commands:
-    - python -m pip install -r docs/requirements.txt
-    - python -m pip install build
     - python -m build .
     - python -m pip install dist/*.whl
+    - tools/install_wheel_extras.sh dist --extra docs
     - mkdir -p docs/tree
     - rm -f docs/tree/*.rst
     - typer qbraid_cli.main utils docs --name=qbraid --output=docs/tree/qbraid.md

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

@@ -32,7 +32,7 @@ qbraid --version
 
 To view available `make` commands, run:
 
-```bash
+```shell
 make help
 ```
 
@@ -40,19 +40,19 @@ make help
 
 Install test dependencies:
 
-```bash
+```shell
 pip install pytest
 ```
 
 And run tests:
 
-```bash
+```shell
 pytest tests
 ```
 
 You can also run tests with make:
 
-```bash
+```shell
 make test
 ```
 
@@ -60,19 +60,19 @@ make test
 
 To generate the API reference documentation locally, install the necessary requirements:
 
-```bash
+```shell
 pip install -r docs/requirements.txt
 ```
 
 And then run
 
-```bash
+```shell
 make docs
 ```
 
 Alternatively, you can generate command tree `.rst` files step-by-step:
 
-```bash
+```shell
 mkdir docs/tree
 typer qbraid_cli.main utils docs --name=qbraid --output=docs/tree/qbraid.md
 m2r docs/tree/qbraid.md
@@ -82,29 +82,31 @@ python tools/split_rst.py docs/tree/qbraid.rst
 
 And then, build the docs:
 
-```bash
+```shell
 sphinx-build -W -b html docs docs/build/html
 ```
 
 You can view the generated documentation in your browser (on OS X) using:
 
-```bash
+```shell
 open docs/build/html/index.html
 ```
 
 ## Code style
 
-For code style, our project uses [ruff](https://github.com/astral-sh/ruff). Specific configurations for these tools should be added to [`pyproject.toml`](pyproject.toml).
+For code style, our project uses a combination of [isort](https://github.com/PyCQA/isort), [pylint](https://github.com/pylint-dev/pylint),
+and [black](https://github.com/psf/black). Specific configurations for these tools should be added to [`pyproject.toml`](pyproject.toml).
 
 Install linters:
 
-```bash
-pip install ruff qbraid-cli
+```shell
+pip install black isort pylint
 ```
 
 Run the following and make changes as needed to satisfy format checks:
 
-```bash
-ruff format qbraid_cli tests tools
-qbraid admin headers qbraid_cli tests tools --type=default --fix
+```shell
+black qbraid_cli tests tools
+isort qbraid_cli tests tools
+pylint qbraid_cli tests tools
 ```

{qbraid_cli-0.8.1 → qbraid_cli-0.8.1a0}/MANIFEST.IN

@@ -1,6 +1,5 @@
 include *.txt *.md
 recursive-include docs *.txt *.rst *.py *.png *.ico
 recursive-include qbraid_cli *.py
-include qbraid_cli/py.typed
 prune docs/build/
-prune docs/cli/
+prune docs/cli/

{qbraid_cli-0.8.1 → qbraid_cli-0.8.1a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.8.1
+Version: 0.8.1a0
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -26,19 +26,26 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-License-File: LICENSE
 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.10
+Requires-Dist: qbraid-core>=0.1.4
 Provides-Extra: jobs
 Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
 Provides-Extra: dev
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: isort; 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.4.0,>=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"
 
 <img width="full" alt="qbraid_cli" src="https://qbraid-static.s3.amazonaws.com/logos/qbraid-cli-banner.png">
 
@@ -47,6 +54,7 @@ Requires-Dist: pytest; extra == "dev"
 [![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.
 
@@ -63,7 +71,7 @@ For help, see qBraid Lab User Guide: [Getting Started](https://docs.qbraid.com/p
 
 You can also install the qBraid-CLI from PyPI with:
 
-```bash
+```shell
 pip install qbraid-cli
 ```
 
@@ -77,13 +85,13 @@ After installation, you must configure your account credentials to use the CLI l
     your [account page](https://account.qbraid.com/):
 3. Save your API key from step 2 in local configuration file `~/.qbraid/qbraidrc` using:
 
-```bash
+```shell
 $ qbraid configure
 ```
 
 ## Basic Commands
 
-```bash
+```shell
 $ qbraid
 ----------------------------------
   * Welcome to the qBraid CLI! * 
@@ -106,19 +114,19 @@ Reference Docs: https://docs.qbraid.com/projects/cli/en/stable/guide/overview.ht
 
 A qBraid CLI command has the following structure:
 
-```bash
+```shell
 $ qbraid <command> <subcommand> [options and parameters]
 ```
 
 For example, to list installed environments, the command would be:
 
-```bash
+```shell
 $ qbraid envs list
 ```
 
 To view help documentation, use one of the following:
 
-```bash
+```shell
 $ qbraid --help
 $ qbraid <command> --help
 $ qbraid <command> <subcommand> --help
@@ -126,7 +134,7 @@ $ qbraid <command> <subcommand> --help
 
 For example:
 
-```bash
+```shell
 $ qbraid --help
 
 Usage: qbraid [OPTIONS] COMMAND [ARGS]...
@@ -150,7 +158,7 @@ Commands
 
 To get the version of the qBraid CLI:
 
-```bash
+```shell
 $ qbraid --version
 ```
 
@@ -158,7 +166,7 @@ $ qbraid --version
 
 You can also access the CLI directly from within [Notebooks](https://docs.qbraid.com/projects/lab/en/latest/lab/notebooks.html) using IPython [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html). First, configure the qBraid magic commands extension using:
 
-```bash
+```shell
 $ qbraid configure magic
 ```
 

{qbraid_cli-0.8.1 → qbraid_cli-0.8.1a0}/README.md

@@ -5,6 +5,7 @@
 [![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.
 
@@ -21,7 +22,7 @@ For help, see qBraid Lab User Guide: [Getting Started](https://docs.qbraid.com/p
 
 You can also install the qBraid-CLI from PyPI with:
 
-```bash
+```shell
 pip install qbraid-cli
 ```
 
@@ -35,13 +36,13 @@ After installation, you must configure your account credentials to use the CLI l
     your [account page](https://account.qbraid.com/):
 3. Save your API key from step 2 in local configuration file `~/.qbraid/qbraidrc` using:
 
-```bash
+```shell
 $ qbraid configure
 ```
 
 ## Basic Commands
 
-```bash
+```shell
 $ qbraid
 ----------------------------------
   * Welcome to the qBraid CLI! * 
@@ -64,19 +65,19 @@ Reference Docs: https://docs.qbraid.com/projects/cli/en/stable/guide/overview.ht
 
 A qBraid CLI command has the following structure:
 
-```bash
+```shell
 $ qbraid <command> <subcommand> [options and parameters]
 ```
 
 For example, to list installed environments, the command would be:
 
-```bash
+```shell
 $ qbraid envs list
 ```
 
 To view help documentation, use one of the following:
 
-```bash
+```shell
 $ qbraid --help
 $ qbraid <command> --help
 $ qbraid <command> <subcommand> --help
@@ -84,7 +85,7 @@ $ qbraid <command> <subcommand> --help
 
 For example:
 
-```bash
+```shell
 $ qbraid --help
 
 Usage: qbraid [OPTIONS] COMMAND [ARGS]...
@@ -108,7 +109,7 @@ Commands
 
 To get the version of the qBraid CLI:
 
-```bash
+```shell
 $ qbraid --version
 ```
 
@@ -116,7 +117,7 @@ $ qbraid --version
 
 You can also access the CLI directly from within [Notebooks](https://docs.qbraid.com/projects/lab/en/latest/lab/notebooks.html) using IPython [magic commands](https://ipython.readthedocs.io/en/stable/interactive/magics.html). First, configure the qBraid magic commands extension using:
 
-```bash
+```shell
 $ qbraid configure magic
 ```
 

{qbraid_cli-0.8.1 → qbraid_cli-0.8.1a0}/docs/index.rst

@@ -109,5 +109,4 @@ Documentation
    tree/qbraid_devices
    tree/qbraid_envs
    tree/qbraid_jobs
-   tree/qbraid_kernels
-   tree/qbraid_pip
+   tree/qbraid_kernels

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-cli"
-version = "0.8.1"
+version = "0.8.1-alpha"
 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" }]
@@ -31,7 +31,7 @@ dependencies = [
     "rich>=10.11.0",
     "jupyter_client>=7.0.0,<9.0.0",
     "ipykernel",
-    "qbraid-core>=0.1.10",
+    "qbraid-core>=0.1.4",
 ]
 requires-python = ">= 3.9"
 
@@ -44,7 +44,8 @@ Discord = "https://discord.gg/KugF6Cnncm"
 
 [project.optional-dependencies]
 jobs = ["amazon-braket-sdk>=1.48.1"]
-dev = ["ruff", "isort", "black", "pytest"]
+dev = ["black", "isort", "pylint", "pytest"]
+docs = ["sphinx>=7.2.6,<7.4.0", "sphinx-rtd-theme>=1.3,<2.1", "docutils<0.22", "toml", "build", "m2r", "typer"]
 
 [project.scripts]
 qbraid = "qbraid_cli.main:app"
@@ -76,26 +77,3 @@ ignore-paths = [
 [tool.pytest.ini_options]
 addopts = "-ra"
 testpaths = ["tests"]
-
-[tool.coverage.run]
-parallel = true
-source = ["qbraid_cli"]
-
-[tool.coverage.report]
-show_missing = true
-skip_covered = true
-ignore_errors = true
-exclude_lines = [
-  "raise NotImplementedError",
-  "return NotImplemented",
-  "def __repr__",
-  "if __name__ == .__main__.:",
-  "if TYPE_CHECKING:",
-  "logger.debug"
-]
-
-[tool.coverage.html]
-directory = "build/coverage"
-
-[tool.coverage.xml]
-output = "build/coverage/coverage.xml"

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

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

{qbraid_cli-0.8.1 → qbraid_cli-0.8.1a0}/qbraid_cli/admin/__init__.py

@@ -7,5 +7,3 @@ Module defining the qbraid admin namespace
 """
 
 from .app import admin_app
-
-__all__ = ["admin_app"]

{qbraid_cli-0.8.1 → qbraid_cli-0.8.1a0}/qbraid_cli/admin/app.py

@@ -3,20 +3,21 @@
 
 """
 Module defining commands in the 'qbraid admin' namespace.
+
 """
 
 from typing import List
 
 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
 
+# disable pretty_exceptions_show_locals to avoid printing sensative information in the traceback
 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,
 )
-admin_app.add_typer(buildlogs_app, name="buildlogs")
 
 
 @admin_app.command(name="headers")

{qbraid_cli-0.8.1 → qbraid_cli-0.8.1a0}/qbraid_cli/configure/__init__.py

@@ -7,5 +7,3 @@ Module defining the qbraid configure namespace
 """
 
 from .app import configure_app
-
-__all__ = ["configure_app"]

{qbraid_cli-0.8.1 → qbraid_cli-0.8.1a0}/qbraid_cli/credits/__init__.py

@@ -7,5 +7,3 @@ Module defining the qbraid credits namespace
 """
 
 from .app import credits_app
-
-__all__ = ["credits_app"]

{qbraid_cli-0.8.1 → qbraid_cli-0.8.1a0}/qbraid_cli/devices/__init__.py

@@ -7,5 +7,3 @@ Module defining the qbraid devices namespace
 """
 
 from .app import devices_app
-
-__all__ = ["devices_app"]

{qbraid_cli-0.8.1 → qbraid_cli-0.8.1a0}/qbraid_cli/envs/__init__.py

@@ -7,5 +7,3 @@ Module defining the qbraid envs namespace
 """
 
 from .app import envs_app
-
-__all__ = ["envs_app"]

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

@@ -10,19 +10,14 @@ import shutil
 import subprocess
 import sys
 from pathlib import Path
-from typing import TYPE_CHECKING, Optional, Tuple
+from typing import Any, Dict, Optional, Tuple
 
 import typer
 from rich.console import Console
 
-from qbraid_cli.envs.create import create_qbraid_env_assets, create_venv
-from qbraid_cli.envs.data_handling import get_envs_data as installed_envs_data
-from qbraid_cli.envs.data_handling import validate_env_name
+from qbraid_cli.envs.data_handling import installed_envs_data, request_delete_env, validate_env_name
 from qbraid_cli.handlers import QbraidException, run_progress_task
 
-if TYPE_CHECKING:
-    from qbraid_core.services.environments.client import EnvironmentManagerClient as EMC
-
 envs_app = typer.Typer(help="Manage qBraid environments.")
 
 
@@ -39,14 +34,25 @@ def envs_create(  # pylint: disable=too-many-statements
     ),
 ) -> None:
     """Create a new qBraid environment."""
-    env_description = description or ""
+    from .create import create_qbraid_env_assets, create_venv
+
+    def request_new_env(req_body: Dict[str, str]) -> Dict[str, Any]:
+        """Send request to create new environment and return the slug."""
+        from qbraid_core import QbraidSession, RequestsApiError
+
+        session = QbraidSession()
+
+        try:
+            env_data = session.post("/environments/create", json=req_body).json()
+        except RequestsApiError as err:
+            raise QbraidException("Create environment request failed") from err
 
-    def create_environment(*args, **kwargs) -> "Tuple[dict, EMC]":
-        """Create a qBraid environment."""
-        from qbraid_core.services.environments.client import EnvironmentManagerClient
+        if env_data is None or len(env_data) == 0 or env_data.get("slug") is None:
+            raise QbraidException(
+                "Create environment request responsed with invalid environment data"
+            )
 
-        client = EnvironmentManagerClient()
-        return client.create_environment(*args, **kwargs), client
+        return env_data
 
     def gather_local_data() -> Tuple[Path, str]:
         """Gather environment data and return the slug."""
@@ -65,10 +71,20 @@ def envs_create(  # pylint: disable=too-many-statements
 
         return env_path, python_version
 
-    environment, emc = run_progress_task(
-        create_environment,
-        name,
-        env_description,
+    req_body = {
+        "name": name,
+        "description": description or "",
+        "tags": "",  # comma separated list of tags
+        "code": "",  # newline separated list of packages
+        "visibility": "private",
+        "kernelName": "",
+        "prompt": "",
+        "origin": "CLI",
+    }
+
+    environment = run_progress_task(
+        request_new_env,
+        req_body,
         description="Validating request...",
         error_message="Failed to create qBraid environment",
     )
@@ -78,6 +94,7 @@ def envs_create(  # pylint: disable=too-many-statements
         description="Solving environment...",
         error_message="Failed to create qBraid environment",
     )
+
     slug = environment.get("slug")
     display_name = environment.get("displayName")
     prompt = environment.get("prompt")
@@ -103,7 +120,7 @@ def envs_create(  # pylint: disable=too-many-statements
     user_confirmation = auto_confirm or typer.confirm("Proceed", default=True)
     typer.echo("")
     if not user_confirmation:
-        emc.delete_environment(slug)
+        request_delete_env(slug)
         typer.echo("qBraidSystemExit: Exiting.")
         raise typer.Exit()
 
@@ -148,13 +165,6 @@ def envs_remove(
 ) -> None:
     """Delete a qBraid environment."""
 
-    def delete_environment(slug: str) -> None:
-        """Delete a qBraid environment."""
-        from qbraid_core.services.environments.client import EnvironmentManagerClient
-
-        emc = EnvironmentManagerClient()
-        emc.delete_environment(slug)
-
     def gather_local_data(env_name: str) -> Tuple[Path, str]:
         """Get environment path and slug from name (alias)."""
         installed, aliases = installed_envs_data()
@@ -180,7 +190,7 @@ def envs_remove(
     if auto_confirm or typer.confirm(confirmation_message, abort=True):
         typer.echo("")
         run_progress_task(
-            delete_environment,
+            request_delete_env,
             slug,
             description="Deleting remote environment data...",
             error_message="Failed to delete qBraid environment",