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

{qbraid_cli-0.8.1a0 → qbraid_cli-0.8.2}/.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.1a0 → qbraid_cli-0.8.2}/.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.1a0 → qbraid_cli-0.8.2}/.github/workflows/main.yml

@@ -64,9 +64,21 @@ jobs:
         shell: pwsh
       - name: Install testing dependencies
         run: |
-          pip install pytest
+          pip install pytest coverage
       - name: Run tests with pytest
         run: |
-          pytest
+          coverage run -m pytest -x tests
+          coverage combine
+          coverage report
+          coverage html
+          coverage xml
         env:
-          QBRAID_API_KEY: ${{ secrets.QBRAID_API_KEY }}
+          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_cli-0.8.1a0 → qbraid_cli-0.8.2}/.readthedocs.yml

@@ -10,9 +10,10 @@ 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.1a0 → qbraid_cli-0.8.2}/CONTRIBUTING.md

@@ -32,7 +32,7 @@ qbraid --version
 
 To view available `make` commands, run:
 
-```shell
+```bash
 make help
 ```
 
@@ -40,19 +40,19 @@ make help
 
 Install test dependencies:
 
-```shell
+```bash
 pip install pytest
 ```
 
 And run tests:
 
-```shell
+```bash
 pytest tests
 ```
 
 You can also run tests with make:
 
-```shell
+```bash
 make test
 ```
 
@@ -60,19 +60,19 @@ make test
 
 To generate the API reference documentation locally, install the necessary requirements:
 
-```shell
+```bash
 pip install -r docs/requirements.txt
 ```
 
 And then run
 
-```shell
+```bash
 make docs
 ```
 
 Alternatively, you can generate command tree `.rst` files step-by-step:
 
-```shell
+```bash
 mkdir docs/tree
 typer qbraid_cli.main utils docs --name=qbraid --output=docs/tree/qbraid.md
 m2r docs/tree/qbraid.md
@@ -82,31 +82,29 @@ python tools/split_rst.py docs/tree/qbraid.rst
 
 And then, build the docs:
 
-```shell
+```bash
 sphinx-build -W -b html docs docs/build/html
 ```
 
 You can view the generated documentation in your browser (on OS X) using:
 
-```shell
+```bash
 open docs/build/html/index.html
 ```
 
 ## Code style
 
-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).
+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).
 
 Install linters:
 
-```shell
-pip install black isort pylint
+```bash
+pip install ruff qbraid-cli
 ```
 
 Run the following and make changes as needed to satisfy format checks:
 
-```shell
-black qbraid_cli tests tools
-isort qbraid_cli tests tools
-pylint qbraid_cli tests tools
+```bash
+ruff format qbraid_cli tests tools
+qbraid admin headers qbraid_cli tests tools --type=default --fix
 ```

qbraid_cli-0.8.2/LICENSE

@@ -0,0 +1,41 @@
+qBraid Closed-Source Software License
+
+Copyright (c) 2024, qBraid Development Team
+
+All rights reserved.
+
+This license agreement ("License") is between the qBraid Development Team ("Author") and you, the Licensee. By using or distributing the qBraid ("Software"), you agree to the following terms:
+
+1. Grant of License.
+
+   Subject to the terms of this License, the Author grants you a non-exclusive, non-transferable license to use the Software for personal, academic, and educational purposes. Use of the Software for commercial purposes is strictly prohibited unless express permission is granted by the Author.
+
+2. Distribution.
+
+   You may distribute the Software to others, provided that any such distribution is made under the same terms of this License. Modifications to the Software may not be distributed.
+
+3. Modification.
+
+   You are permitted to modify the Software for personal use. You may contribute improvements or bug fixes back to the Author or the community, but you may not distribute the modifications.
+
+4. Commercial Use.
+
+   The Software may not be used for commercial purposes without explicit, prior written permission from the Author. Permissions for commercial use will be considered on a case-by-case basis.
+
+5. Attribution
+
+   If the Software is used in a non-private setting, including but not limited to academic work, commercial settings, or published literature, attribution must be given to the "qBraid Jupyter Environment Manager authored by the qBraid Development Team."
+
+6. Disclaimer of Warranty.
+
+   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.
+
+7. Limitation of Liability.
+
+   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.
+
+8. Termination.
+
+   This License is effective until terminated. Your rights under this License will terminate automatically without notice from the Author if you fail to comply with any term(s) of this License.
+
+By using the Software, you agree to be bound by the terms of this License. Redistribution of the Software or use of the Software other than as specifically authorized under this License is prohibited and may result in severe civil and criminal penalties.

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

@@ -1,5 +1,6 @@
 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.1a0 → qbraid_cli-0.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.8.1a0
+Version: 0.8.2
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Author-email: qBraid Development Team <contact@qbraid.com>
 License: Proprietary
@@ -26,26 +26,19 @@ 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.4
+Requires-Dist: qbraid-core>=0.1.13
 Provides-Extra: jobs
 Requires-Dist: amazon-braket-sdk>=1.48.1; extra == "jobs"
 Provides-Extra: dev
-Requires-Dist: black; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
 Requires-Dist: isort; extra == "dev"
-Requires-Dist: pylint; extra == "dev"
+Requires-Dist: black; 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">
 
@@ -54,7 +47,6 @@ Requires-Dist: typer; extra == "docs"
 [![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.
 
@@ -71,7 +63,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:
 
-```shell
+```bash
 pip install qbraid-cli
 ```
 
@@ -85,13 +77,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:
 
-```shell
+```bash
 $ qbraid configure
 ```
 
 ## Basic Commands
 
-```shell
+```bash
 $ qbraid
 ----------------------------------
   * Welcome to the qBraid CLI! * 
@@ -114,19 +106,19 @@ Reference Docs: https://docs.qbraid.com/projects/cli/en/stable/guide/overview.ht
 
 A qBraid CLI command has the following structure:
 
-```shell
+```bash
 $ qbraid <command> <subcommand> [options and parameters]
 ```
 
 For example, to list installed environments, the command would be:
 
-```shell
+```bash
 $ qbraid envs list
 ```
 
 To view help documentation, use one of the following:
 
-```shell
+```bash
 $ qbraid --help
 $ qbraid <command> --help
 $ qbraid <command> <subcommand> --help
@@ -134,7 +126,7 @@ $ qbraid <command> <subcommand> --help
 
 For example:
 
-```shell
+```bash
 $ qbraid --help
 
 Usage: qbraid [OPTIONS] COMMAND [ARGS]...
@@ -158,7 +150,7 @@ Commands
 
 To get the version of the qBraid CLI:
 
-```shell
+```bash
 $ qbraid --version
 ```
 
@@ -166,7 +158,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:
 
-```shell
+```bash
 $ qbraid configure magic
 ```
 

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

@@ -5,7 +5,6 @@
 [![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.
 
@@ -22,7 +21,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:
 
-```shell
+```bash
 pip install qbraid-cli
 ```
 
@@ -36,13 +35,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:
 
-```shell
+```bash
 $ qbraid configure
 ```
 
 ## Basic Commands
 
-```shell
+```bash
 $ qbraid
 ----------------------------------
   * Welcome to the qBraid CLI! * 
@@ -65,19 +64,19 @@ Reference Docs: https://docs.qbraid.com/projects/cli/en/stable/guide/overview.ht
 
 A qBraid CLI command has the following structure:
 
-```shell
+```bash
 $ qbraid <command> <subcommand> [options and parameters]
 ```
 
 For example, to list installed environments, the command would be:
 
-```shell
+```bash
 $ qbraid envs list
 ```
 
 To view help documentation, use one of the following:
 
-```shell
+```bash
 $ qbraid --help
 $ qbraid <command> --help
 $ qbraid <command> <subcommand> --help
@@ -85,7 +84,7 @@ $ qbraid <command> <subcommand> --help
 
 For example:
 
-```shell
+```bash
 $ qbraid --help
 
 Usage: qbraid [OPTIONS] COMMAND [ARGS]...
@@ -109,7 +108,7 @@ Commands
 
 To get the version of the qBraid CLI:
 
-```shell
+```bash
 $ qbraid --version
 ```
 
@@ -117,7 +116,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:
 
-```shell
+```bash
 $ qbraid configure magic
 ```
 

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

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

qbraid_cli-0.8.2/docs/requirements.txt

@@ -0,0 +1,7 @@
+sphinx>=7.2.6,<7.4.0
+sphinx-rtd-theme>=1.3,<2.1
+docutils<0.22
+toml
+build
+m2r
+typer

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "qbraid-cli"
-version = "0.8.1-alpha"
+version = "0.8.2"
 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.4",
+    "qbraid-core>=0.1.13",
 ]
 requires-python = ">= 3.9"
 
@@ -44,8 +44,7 @@ Discord = "https://discord.gg/KugF6Cnncm"
 
 [project.optional-dependencies]
 jobs = ["amazon-braket-sdk>=1.48.1"]
-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"]
+dev = ["ruff", "isort", "black", "pytest"]
 
 [project.scripts]
 qbraid = "qbraid_cli.main:app"
@@ -77,3 +76,26 @@ 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.1a0 → qbraid_cli-0.8.2}/qbraid_cli/_version.py

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

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

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

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

@@ -3,21 +3,20 @@
 
 """
 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.2/qbraid_cli/admin/buildlogs.py

@@ -0,0 +1,114 @@
+# Copyright (c) 2024, qBraid Development Team
+# All rights reserved.
+
+"""
+Module defining commands in the 'qbraid admin buildlogs' namespace.
+
+This module uses the Typer library to create CLI commands for managing Docker builds and logs
+in an administrative context.
+"""
+
+import json
+
+import typer
+from qbraid_core.exceptions import RequestsApiError
+from qbraid_core.services.admin.client import AdminClient
+from rich.console import Console
+
+from qbraid_cli.handlers import handle_error
+
+buildlogs_app = typer.Typer(
+    help="Manage qBraid containerized services logs.", pretty_exceptions_show_locals=False
+)
+console = Console()
+
+
+@buildlogs_app.command(name="get")
+def get_docker_build_logs(
+    build_id: str = typer.Option(None, "--build_id", "-b", help="Name of the build ID")
+) -> None:
+    """
+    Fetches and displays Docker build logs for a specified build ID.
+
+    Args:
+        build_id (str, optional): The unique identifier for the Docker build.
+
+    This function queries the administrative backend to retrieve and display build logs.
+    If a build ID is provided, it will retrieve and display logs specific to that build ID.
+    If build ID not provided, fetches all logs.
+    """
+    client = AdminClient()
+
+    build_log = client.get_docker_build_logs(build_id)
+    if build_id and "buildLogs" in build_log and build_log["buildLogs"]:
+        log_entry = build_log["buildLogs"][0]
+        console.print(log_entry)
+    else:
+        console.print(build_log)
+
+
+@buildlogs_app.command(name="post")
+def post_docker_build_log(
+    data: str = typer.Option(..., "--data", "-d", help="Data to post to Docker logs")
+) -> None:
+    """
+    Posts a new Docker build log entry.
+
+    Args:
+        data (str): JSON string containing the data to be logged.
+
+    This command converts a JSON string into a dictionary and sends it to the backend service
+    to create a new Docker build log.
+    """
+    client = AdminClient()
+
+    try:
+        data_dict = json.loads(data)
+        console.print(client.post_docker_build_logs(data_dict))
+    except RequestsApiError:
+        handle_error(message="Couldn't post a build_log.")
+
+
+@buildlogs_app.command(name="put")
+def put_docker_build_log(
+    build_id: str = typer.Option(..., "--build_id", "-b", help="Name of the build ID"),
+    data: str = typer.Option(..., "--data", "-d", help="Data to post to Docker logs"),
+) -> None:
+    """
+    Updates an existing Docker build log entry by a given build ID.
+
+    Args:
+        build_id (str): The unique identifier of the Docker build to update.
+        data (str): JSON string containing the updated data for the log.
+
+    This command updates a Docker build log entry, identified by the provided build ID,
+    with the new data provided in JSON format.
+    """
+    client = AdminClient()
+
+    try:
+        data_dict = json.loads(data)
+        console.print(client.put_docker_build_logs(build_id, data_dict))
+    except RequestsApiError:
+        handle_error(message="Couldn't post a build_log.")
+
+
+@buildlogs_app.command(name="delete")
+def delete_docker_build_log(
+    build_id: str = typer.Option(..., "--build_id", "-b", help="ID of the build log to delete")
+) -> None:
+    """
+    Deletes a Docker build log entry by a specified build ID.
+
+    Args:
+        build_id (str): The unique identifier of the Docker build log to delete.
+
+    This command sends a request to delete a Docker build log identified by the provided build ID.
+    """
+    client = AdminClient()
+
+    console.print(client.delete_docker_build_logs(build_id))
+
+
+if __name__ == "__main__":
+    buildlogs_app()

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

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

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

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

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

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

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

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