qbraid-cli 0.7.1__tar.gz → 0.8.0__tar.gz

qbraid_cli-0.8.0/.env.example

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

qbraid_cli-0.8.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,41 @@
+name: Bug report 🚩
+description: Create a report to help us improve
+title: "[BUG] "
+labels: [bug]
+
+body:
+  - type: markdown
+    attributes:
+      value: "Thanks for taking the time to fill out our bug report form."
+
+  - type: textarea
+    attributes:
+      label: Environment
+      value: |
+        - **qBraid-CLI version**:
+        - **Python version**:
+        - **Operating system**:
+    validations:
+      required: true
+  
+  - type: textarea
+    attributes:
+      label: What happened?
+      description: Please provide a detailed description of the bug, accompanied by a minimal code example that demonstrates how the error(s) can be reproduced.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Suggestions (Optional)
+      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/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,34 @@
+name: Feature request 💡
+description: Suggest an idea for this project
+title: "[FEATURE] "
+labels: [enhancement]
+
+body:
+  - type: markdown
+    attributes:
+      value: "Thank you for taking the time to suggest a feature. Please fill out the details below to help us understand your idea better."
+
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: Feature Description
+      description: "Describe the feature you'd like and the problem it solves. Include any specific use cases that illustrate its benefits."
+      placeholder: "Please describe the feature in detail."
+    validations:
+      required: true
+  
+  - type: textarea
+    attributes:
+      label: Implementation (Optional)
+      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.8.0/.github/PULL_REQUEST_TEMPLATE.md

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

qbraid_cli-0.8.0/.github/workflows/docs.yml

@@ -0,0 +1,39 @@
+name: Build Docs
+
+on:
+  pull_request:
+    branches: ['main']
+  push:
+    branches: ['main']
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+        cache: pip
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip setuptools
+        python -m pip install -r docs/requirements.txt
+    - name: Build & install package
+      run: |
+        python -m build .
+        python -m pip install dist/*.whl
+    - 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.8.0/.github/workflows/format.yml

@@ -0,0 +1,34 @@
+name: Formatting check
+
+on:
+  pull_request:
+      branches: ['main']
+  workflow_dispatch:
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install black isort pylint
+      - name: Check isort, black, pylint
+        run: |
+          black --check qbraid_cli tests tools
+          isort --check-only qbraid_cli tests tools
+          # if pylint qbraid_cli tests tools --disable=C0415,R0914,W0511 2>&1 | grep 'Your code has been rated at 10\.00/10' > /dev/null; then
+          #   echo "Perfect pylint score!"
+          # else
+          #   echo "Pylint score is not 10/10."
+          #   exit 1
+          # fi
+      - name: Check copyright headers
+        run: |
+          python tools/verify_headers.py qbraid_cli tests tools --skip qbraid_cli/_version.py

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

@@ -0,0 +1,72 @@
+name: CI
+
+on:
+  pull_request:
+    branches: ['main']
+  push:
+    branches: ['main']
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.11']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        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@v3
+        with:
+          name: built-package
+          path: dist/*.whl
+
+  test:
+    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@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - name: Download built package
+        uses: actions/download-artifact@v3
+        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
+      - name: Run tests with pytest
+        run: |
+          pytest
+        env:
+          QBRAID_API_KEY: ${{ secrets.QBRAID_API_KEY }}

qbraid_cli-0.8.0/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+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
+        with:
+          fetch-depth: 1
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Build binary wheel + source tarball
+        run: |
+          python3 -m pip install --upgrade pip build
+          python3 -m build
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

qbraid_cli-0.8.0/.github/workflows/test-publish.yml

@@ -0,0 +1,29 @@
+name: Publish to TestPyPI
+
+on:
+  workflow_dispatch:
+
+jobs:
+  pypi-publish:
+    name: Build dist & upload to TestPyPI
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 1
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Build binary wheel + source tarball
+        run: |
+          python3 -m pip install --upgrade pip build
+          python3 -m build
+      - name: Publish package to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          repository-url: https://test.pypi.org/legacy/

qbraid_cli-0.8.0/.gitignore

@@ -0,0 +1,164 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+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
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  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/

qbraid_cli-0.8.0/.readthedocs.yml

@@ -0,0 +1,22 @@
+# 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:
+    - pip install -r docs/requirements.txt
+    - python -m build .
+    - python -m pip install dist/*.whl
+    - 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.8.0/CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# Contributing
+
+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:
+
+```shell
+make help
+```
+
+## Testing
+
+Install test dependencies:
+
+```shell
+pip install pytest
+```
+
+And run tests:
+
+```shell
+pytest tests
+```
+
+You can also run tests with make:
+
+```shell
+make test
+```
+
+## Build docs
+
+To generate the API reference documentation locally, install the necessary requirements:
+
+```shell
+pip install -r docs/requirements.txt
+```
+
+And then run
+
+```shell
+make docs
+```
+
+Alternatively, you can generate command tree `.rst` files step-by-step:
+
+```shell
+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:
+
+```shell
+sphinx-build -W -b html docs docs/build/html
+```
+
+You can view the generated documentation in your browser (on OS X) using:
+
+```shell
+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).
+
+Install linters:
+
+```shell
+pip install black isort pylint
+```
+
+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
+```

qbraid_cli-0.8.0/MANIFEST.IN

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

qbraid_cli-0.8.0/Makefile

@@ -0,0 +1,52 @@
+.PHONY: help docs clean build check_dependencies
+
+DOCS_DIR := docs
+BUILD_DIR := $(DOCS_DIR)/build
+TREE_DIR := $(DOCS_DIR)/tree
+DIST_DIR := dist
+SRC_DIR := qbraid_cli
+TOOLS_DIR := tools
+TESTS_DIR := tests
+
+.DEFAULT_GOAL := help
+
+help: ## Display this help message
+	@echo "Available commands:"
+	@echo
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-30s\033[0m %s\n", $$1, $$2}'
+	@echo
+
+docs: check_dependencies_docs check_build_version ## Generate documentation
+	@python -c "import pathlib; pathlib.Path('$(TREE_DIR)').mkdir(parents=True, exist_ok=True)"
+	@python -c "import glob, os; [os.remove(f) for f in glob.glob('$(TREE_DIR)/*.rst')]"
+	@typer qbraid_cli.main utils docs --name=qbraid --output=$(TREE_DIR)/qbraid.md
+	@m2r $(TREE_DIR)/qbraid.md
+	@python -c "import os; os.remove('$(TREE_DIR)/qbraid.md')"
+	@python $(TOOLS_DIR)/split_rst.py $(TREE_DIR)/qbraid.rst
+	@sphinx-build -W -b html $(DOCS_DIR) $(BUILD_DIR)
+
+test: check_dependencies_test ## Run tests with pytest
+	@python -m pytest $(TESTS_DIR)
+
+clean: ## Clean up generated docs and build artifacts
+	@python -c "import shutil; shutil.rmtree('$(BUILD_DIR)', ignore_errors=True)"
+	@python -c "import shutil; shutil.rmtree('$(TREE_DIR)', ignore_errors=True)"
+	@python -c "import shutil; shutil.rmtree('$(DIST_DIR)', ignore_errors=True)"
+	@python -c "import os; os.remove('$(SRC_DIR)/_version.py') if os.path.exists('$(SRC_DIR)/_version.py') else None"
+
+build: check_dependencies_build ## Build the package
+	@python -m build .
+
+check_build_version:
+	@python -c "import os; assert os.path.exists('$(SRC_DIR)/_version.py'), 'Error: $(SRC_DIR)/_version.py does not exist. Please \'make build\' before proceeding.'"
+
+check_dependencies_docs:
+	@command -v typer >/dev/null 2>&1 || { echo >&2 "Error: Python 'typer-cli' module is not installed. Please install it to proceed."; exit 1; }
+	@command -v m2r >/dev/null 2>&1 || { echo >&2 "Error: Python 'm2r' module is not installed. Please install it to proceed."; exit 1; }
+	@command -v sphinx-build >/dev/null 2>&1 || { echo >&2 "Error: Python 'sphinx' module is not installed. Please install it to proceed."; exit 1; }
+
+check_dependencies_test:
+	@python -c "import pytest" 2>/dev/null || { echo >&2 "Error: Python 'pytest' module is not installed. Please install it to proceed."; exit 1; }
+
+check_dependencies_build:
+	@python -c "import build" 2>/dev/null || { echo >&2 "Error: Python 'build' module is not installed. Please install it to proceed."; exit 1; }