qbraid-cli 0.8.0.dev1__tar.gz → 0.9.6__tar.gz

qbraid_cli-0.9.6/.env.example

@@ -0,0 +1,4 @@
+QBRAID_API_KEY= # YOURAPIKEY
+QBRAID_ENVS_PATH= # default: ~/.qbraid/environments
+QBRAID_CONFIG_FILE= # default: ~/.qbraid/qbraidrc
+QBRAID_CLI_SHOW_PROGRESS= # default: true

{qbraid-cli-0.8.0.dev1 → qbraid_cli-0.9.6}/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -12,6 +12,7 @@ body:
     attributes:
       label: Environment
       value: |
+        - **qBraid-CORE version**:
         - **qBraid-CLI version**:
         - **Python version**:
         - **Operating system**:
@@ -31,11 +32,3 @@ body:
       description: We warmly welcome any recommendations on potential fixes, insights, or considerations that contributors should keep in mind when working to resolve this issue.
     validations:
       required: false
-
-  - type: checkboxes
-    id: agreement
-    attributes:
-      label: 'Please confirm the following:'
-      options:
-        - label: 'I have searched the existing issues and confirm this is a new bug report.'
-          required: true

{qbraid-cli-0.8.0.dev1 → qbraid_cli-0.9.6}/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -23,12 +23,3 @@ body:
       description: "Do you have an idea for how this could be implemented? Please include those details here."
     validations:
       required: false
-
-  - type: checkboxes
-    id: agreement
-    attributes:
-      label: 'Please confirm the following:'
-      description: 'Understanding that feature requests are evaluated for their applicability and benefit to the community, and not all requests may be implemented.'
-      options:
-        - label: 'I have searched the existing issues and confirm this is a new feature request.'
-          required: true

qbraid_cli-0.9.6/.github/PULL_REQUEST_TEMPLATE.md

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

qbraid_cli-0.9.6/.github/workflows/bump-version.yml

@@ -0,0 +1,71 @@
+name: Bump Version
+
+on:
+  workflow_dispatch:
+    inputs:
+      bump_type:
+        description: 'Select the version bump type'
+        required: true
+        type: choice
+        options:
+          - major
+          - minor
+          - patch
+        default: 'patch'
+
+jobs:
+  bump-version:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: 'main'
+
+      - name: Create feature branch
+        run: git checkout -b qbraid-bot/${{ github.run_id }}
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install "qbraid-core>=0.1.17"
+
+      - name: Setup Git config
+        run: |
+          git config --global user.name 'qbraidTeam'
+          git config --global user.email 'qbraid.team@qbraid.com'
+
+      - name: Bump version, commit and push
+        id: bump_version
+        run: |
+          BUMP_TYPE=${{ github.event.inputs.bump_type }}
+          VERSION=$(python3 tools/bump_version.py qbraid_cli $BUMP_TYPE)
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+          git commit -am "Bump $BUMP_TYPE version to $VERSION"
+          git push origin qbraid-bot/${{ github.run_id }}
+
+      - name: Create Pull Request
+        id: create_pr
+        run: |
+          VERSION=${{ steps.bump_version.outputs.version }}
+          PR_URL=$(gh pr create -B main -H qbraid-bot/${{ github.run_id }} --title "Bump project version to $VERSION" --body "This PR bumps the project version to $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.GITHUB_TOKEN }}
+
+      - name: Summary
+        run: |
+          VERSION=${{ steps.bump_version.outputs.version }}
+          PR_URL=${{ steps.create_pr.outputs.url }}
+          PR_NUMBER=${{ steps.create_pr.outputs.number }}
+          echo "Opened PR [#$PR_NUMBER]($PR_URL) to update project to version **$VERSION**." >> $GITHUB_STEP_SUMMARY

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

@@ -0,0 +1,128 @@
+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.8.0.dev1 → qbraid_cli-0.9.6}/.github/workflows/docs.yml

@@ -3,29 +3,31 @@ name: Build Docs
 on:
   pull_request:
     branches: ['main']
+    types: [opened, reopened, ready_for_review, synchronize]
   push:
     branches: ['main']
   workflow_dispatch:
 
 jobs:
   build:
+    if: github.event.pull_request.draft == false
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
-        python-version: '3.10'
+        python-version: '3.11'
         cache: pip
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip setuptools
+        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 envs
     - name: Generate docs assets
       run: |
         python -c "import pathlib; pathlib.Path('docs/tree').mkdir(parents=True, exist_ok=True)"

qbraid_cli-0.9.6/.github/workflows/format.yml

@@ -0,0 +1,30 @@
+name: Format
+
+on:
+  pull_request:
+      branches: ['main']
+      types: [opened, reopened, ready_for_review, synchronize]
+  workflow_dispatch:
+
+jobs:
+  check:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install black isort pylint qbraid-cli
+      - name: Check isort, black, pylint
+        run: |
+          black --check qbraid_cli tests tools
+          isort --check-only qbraid_cli tests tools
+      - name: Check copyright headers
+        run: |
+          qbraid admin headers qbraid_cli tests tools

qbraid_cli-0.9.6/.github/workflows/main.yml

@@ -0,0 +1,83 @@
+name: CI
+
+on:
+  pull_request:
+    branches: ['main']
+    types: [opened, reopened, ready_for_review, synchronize]
+  push:
+    branches: ['main']
+  workflow_dispatch:
+
+jobs:
+  build:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.11']
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - name: Upgrade pip and install build tools
+        run: |
+          pip install --upgrade pip
+          pip install setuptools wheel build
+      - name: Build the package
+        run: |
+          python -m build
+      - name: Upload built package
+        uses: actions/upload-artifact@v4
+        with:
+          name: built-package
+          path: dist/*.whl
+
+  test:
+    if: github.event.pull_request.draft == false
+    needs: build
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - name: Download built package
+        uses: actions/download-artifact@v4
+        with:
+          name: built-package
+          path: dist
+      - name: Install package
+        run: |
+          if ($env:RUNNER_OS -eq "Windows") {
+            Get-ChildItem dist/*.whl | ForEach-Object { pip install $_.FullName }
+          } else {
+            pip install dist/*.whl
+          }
+        shell: pwsh
+      - name: Install testing dependencies
+        run: |
+          pip install pytest pytest-cov qbraid-core[environments]
+      - name: Run tests with pytest
+        run: |
+          pytest --cov=qbraid_cli tests/ --cov-report=html --cov-report=xml --cov-report=term --cov-config=pyproject.toml
+        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@v4.4.1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: false
+          files: ./build/coverage/coverage.xml
+          verbose: true

qbraid_cli-0.9.6/.github/workflows/pre-release.yml

@@ -0,0 +1,38 @@
+name: Pre-release to PyPI
+
+on:
+  workflow_dispatch:
+
+jobs:
+  pypi-publish:
+    name: Build pre-release dist & upload to PyPI
+    environment: publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install build dependencies
+        run: python -m pip install -U pip wheel build toml-cli qbraid-core
+
+      - name: Build binary wheel + source tarball
+        id: build-dev
+        run: |
+            export PRE_RELEASE_VERSION=$(python tools/stamp_pre_release.py qbraid_cli)
+            [[ "$PRE_RELEASE_VERSION" =~ .*(-a\.|-b\.|-rc\.).* ]] && echo "Deploying pre-release version '$PRE_RELEASE_VERSION'" || (echo "not pre-release version"; exit 0)
+            out_dir="${PWD}/dist"
+            tools/create_dev_build.sh $PRE_RELEASE_VERSION "${out_dir}"
+            echo "dir=$out_dir" >> $GITHUB_OUTPUT
+
+      - name: Publish pre-release package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          packages-dir: ${{ steps.build-dev.outputs.dir }}

{qbraid-cli-0.8.0.dev1 → qbraid_cli-0.9.6}/.github/workflows/publish.yml

@@ -1,23 +1,22 @@
 name: Publish to PyPI
 
 on:
-  release:
-    types: [published]
   workflow_dispatch:
 
 jobs:
   pypi-publish:
     name: Build dist & upload to PyPI
+    environment: publish
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 1
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
-          python-version: '3.10'
+          python-version: '3.11'
 
       - name: Build binary wheel + source tarball
         run: |

qbraid_cli-0.9.6/.github/workflows/tag-on-merge.yml

@@ -0,0 +1,36 @@
+name: Tag on PR Merge
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  tag-version:
+    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
+    permissions:
+      contents: write
+    steps:
+      - name: Extract version
+        id: extract_version
+        run: |
+          VERSION=$(echo '${{ github.event.pull_request.title }}' | sed -E 's/Bump project version to (.*)/\1/')
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: 'main'
+
+      - name: Setup Git config
+        run: |
+          git config --global user.name 'qbraidTeam'
+          git config --global user.email 'qbraid.team@qbraid.com'
+
+      - name: Create Tag
+        run: |
+          VERSION=${{ steps.extract_version.outputs.version }}
+          git tag v$VERSION
+          git push origin v$VERSION
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{qbraid-cli-0.8.0.dev1 → qbraid_cli-0.9.6}/.gitignore

@@ -3,6 +3,9 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+.DS_Store
+.vscode
+
 # C extensions
 *.so
 
@@ -161,4 +164,4 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/

{qbraid-cli-0.8.0.dev1 → qbraid_cli-0.9.6}/.readthedocs.yml

@@ -10,9 +10,10 @@ build:
   tools:
     python: "3.10"
   commands:
-    - pip install -r docs/requirements.txt
+    - 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 envs
     - 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.0.dev1 → qbraid_cli-0.9.6}/CONTRIBUTING.md

@@ -1,5 +1,8 @@
 # Contributing
 
+[![CI](https://github.com/qBraid/qBraid-CLI/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/qBraid/qBraid-CLI/actions/workflows/main.yml)
+[![codecov](https://codecov.io/gh/qBraid/qBraid-CLI/graph/badge.svg?token=wVNrLILy9c)](https://codecov.io/gh/qBraid/qBraid-CLI)
+
 Welcome! We're delighted that you're interested in contributing. Your help is essential for keeping the project great.
 
 ## Getting Started
@@ -32,27 +35,33 @@ qbraid --version
 
 To view available `make` commands, run:
 
-```shell
+```bash
 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:
 
-```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 +69,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 +91,32 @@ 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 a combination of [isort](https://github.com/PyCQA/isort), [pylint](https://github.com/pylint-dev/pylint), [black](https://github.com/psf/black), and [mypy](https://github.com/python/mypy). Specific configurations for these tools should be added to [`pyproject.toml`](pyproject.toml).
 
 Install linters:
 
-```shell
-pip install black isort pylint
+```bash
+pip install black isort pylint mypy
 ```
 
 Run the following and make changes as needed to satisfy format checks:
 
-```shell
+```bash
 black qbraid_cli tests tools
 isort qbraid_cli tests tools
 pylint qbraid_cli tests tools
+mypy qbraid_cli tests tools
+qbraid admin headers qbraid_cli tests tools --type=default --fix
 ```

qbraid_cli-0.9.6/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.