qbraid-cli 0.8.0.dev0__tar.gz → 0.9.5__tar.gz

qbraid_cli-0.9.5/.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.dev0 → qbraid_cli-0.9.5}/.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.dev0 → qbraid_cli-0.9.5}/.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.5/.github/PULL_REQUEST_TEMPLATE.md

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

qbraid_cli-0.9.5/.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.5/.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.9.5/.github/workflows/docs.yml

@@ -0,0 +1,41 @@
+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@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+        cache: pip
+    - 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 .
+        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)"
+        python -c "import glob, os; [os.remove(f) for f in glob.glob('docs/tree/*.rst')]"
+        typer qbraid_cli.main utils docs --name=qbraid --output=docs/tree/qbraid.md
+        m2r docs/tree/qbraid.md
+        python -c "import os; os.remove('docs/tree/qbraid.md')"
+        python tools/split_rst.py docs/tree/qbraid.rst
+    - name: Build docs
+      run: |
+        sphinx-build -W -b html docs docs/build/html

qbraid_cli-0.9.5/.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.5/.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.5/.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.dev0 → qbraid_cli-0.9.5}/.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.5/.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.dev0 → qbraid_cli-0.9.5}/.gitignore

@@ -3,6 +3,9 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+.DS_Store
+.vscode
+
 # C extensions
 *.so
 
@@ -28,6 +31,7 @@ MANIFEST
 
 # ignore autogenerated _version.py file
 qbraid_cli/_version.py
+docs/tree/*
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -160,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.9.5/.readthedocs.yml

@@ -0,0 +1,23 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.10"
+  commands:
+    - python -m pip install -r docs/requirements.txt
+    - python -m pip install build
+    - python -m build .
+    - 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
+    - m2r docs/tree/qbraid.md
+    - rm docs/tree/qbraid.md
+    - python tools/split_rst.py docs/tree/qbraid.rst
+    - sphinx-build -W -b html docs $READTHEDOCS_OUTPUT/html

qbraid_cli-0.9.5/CONTRIBUTING.md

@@ -0,0 +1,122 @@
+# 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
+
+Before you start working on a new feature or a fix, here's how you can contribute:
+
+1. **Fork the repository**: Visit the GitHub page of our project and use the "Fork" button to create a copy of the project in your own GitHub account.
+2. **Create a Development Branch**: After forking, clone the repository to your local machine and create a new branch for your development. Use a descriptive name for your branch, such as `feature-<feature-name>` or `bugfix-<bug-description>`.
+3. **Commit Your Changes**: Make your changes in your development branch and commit them. Be sure to write clear, concise commit messages.
+4. **Push to Your Fork**: Push your changes to your forked repository on GitHub.
+5. **Create a Pull Request**: Go to the original project repository and click on "Pull Requests", then click the "New Pull Request" button
+
+### Development install
+
+You can install the qBraid-CLI from source by cloning this repository and running a pip install command in the root directory:
+
+```bash
+git clone https://github.com/qBraid/qBraid-CLI.git
+cd qBraid-CLI
+pip install -e .
+```
+
+*Note*: The current CLI configuration assumes a Linux-based filesystem. However, our goal is to move towards a platform agnostic version soon.
+
+You can verify that the setup has been successful by checking the qBraid-CLI version with the following command:
+
+```bash
+qbraid --version
+```
+
+To view available `make` commands, run:
+
+```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:
+
+```bash
+pip install pytest
+```
+
+And run tests:
+
+```bash
+pytest tests
+```
+
+You can also run tests with make:
+
+```bash
+make test
+```
+
+## Build docs
+
+To generate the API reference documentation locally, install the necessary requirements:
+
+```bash
+pip install -r docs/requirements.txt
+```
+
+And then run
+
+```bash
+make docs
+```
+
+Alternatively, you can generate command tree `.rst` files step-by-step:
+
+```bash
+mkdir docs/tree
+typer qbraid_cli.main utils docs --name=qbraid --output=docs/tree/qbraid.md
+m2r docs/tree/qbraid.md
+rm docs/tree/qbraid.md
+python tools/split_rst.py docs/tree/qbraid.rst
+```
+
+And then, build the docs:
+
+```bash
+sphinx-build -W -b html docs docs/build/html
+```
+
+You can view the generated documentation in your browser (on OS X) using:
+
+```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), [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:
+
+```bash
+pip install black isort pylint mypy
+```
+
+Run the following and make changes as needed to satisfy format checks:
+
+```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
+```