qbraid-cli 0.6.1__tar.gz → 0.7.0__tar.gz

{qbraid-cli-0.6.1 → qbraid-cli-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.6.1
+Version: 0.7.0
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Home-page: https://www.qbraid.com/
 Author: qBraid Development Team
@@ -16,14 +16,15 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >= 3.8
 Description-Content-Type: text/markdown
+Requires-Dist: qbraid>=0.5.0
 Requires-Dist: awscli
+Requires-Dist: ipykernel
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: isort; extra == "dev"

{qbraid-cli-0.6.1 → qbraid-cli-0.7.0}/qbraid_cli/_version.py

@@ -4,4 +4,4 @@ Module containing version information
 Version number (major.minor.patch[-label])
 
 """
-__version__ = "0.6.1"
+__version__ = "0.7.0"

{qbraid-cli-0.6.1 → qbraid-cli-0.7.0}/qbraid_cli/bin/qbraid.sh

@@ -10,9 +10,6 @@
 #-------------------------------------------------------------------------
 # Global variables
 
-# CLI version (DEPRECATED, now kept by python _version.py)
-VERSION="0.6.0.dev0"
-
 # Styling
 NC="\033[0m" # No Color
 PURPLE="\033[0;35m"
@@ -890,19 +887,6 @@ help_jobs_add() {
     echo ""
 }
 
-# qbraid jobs get-credits -h
-help_jobs_credits() {
-    echo ""
-    echo "Command"
-    echo "    qbraid jobs get-credits    : Get number of qBraid credits remaining." 
-    echo "                                 Recently added credits may not appear, but"
-    echo "                                 will be synced after submitting quantum job."
-    echo ""
-    echo "Optional Arguments"
-    echo "    -h, --help                 : Show this help message and exit."
-    echo ""
-}
-
 # qbraids jobs enable -h
 help_jobs_enable() {
     echo ""
@@ -962,15 +946,6 @@ jobs() {
         ((argDepth++))
         if [ "$(help_command "${argDepth}")" = "yes" ]; then
             help_jobs_list
-        else
-            awsJobs="$HOME/.qbraid/quantum-jobs/aws"
-            if [ ! -f "${awsJobs}" ] || [ "$(cat "${awsJobs}" | wc -l)" = 0 ]; then 
-                echo -e "${RED}No quantum jobs found.${NC}"
-                echo ""
-                echo -e "Use \`qbraid jobs enable -h\` for information on enabling qBraid Quantum Jobs."
-            else
-                cat "${awsJobs}"
-            fi
         fi
  
     # qbraid jobs add
@@ -1148,6 +1123,66 @@ jobs() {
     fi
 }
 
+############################### DEVICES GROUP ###############################
+#-------------------------------------------------------------------------
+# Help functions
+
+# qbraid devices -h
+help_devices() {
+    echo ""
+    echo "Group"
+    echo "    qbraid devices         : Manage qBraid Quantum Devices."
+    echo ""
+    echo "Commands"
+    echo "    list                   : Get list of qBraid Quantum Devices."
+    echo ""
+    echo "Optional Arguments"
+    echo "    -h, --help             : Show this help message and exit."
+    echo ""
+}
+
+# qbraid devices list -h
+help_devices_list() {
+    echo ""
+    echo "Command"
+    echo "    qbraid devices list    : Get list of qBraid Quantum Jobs."
+    echo ""
+    echo "Optional Arguments"
+    echo "    -h, --help             : Show this help message and exit."
+    echo ""
+}
+
+#-------------------------------------------------------------------------
+# qbraid devices commands
+
+devices() {
+
+    argDepth=2
+    
+    # qbraid jobs -h
+    if [ "$(help_command "${argDepth}")" = "yes" ]; then
+        help_devices
+
+    # qbraid jobs
+    elif [ -z "${1}" ]; then
+        echo -e "${RED}ERROR: Invalid command ${NC}"
+        echo ""
+        echo -e "Use \`qbraid devices -h\` to see available commands"
+        exit 1
+    
+    # qbraid devices list
+    elif [ "${1}" = "list" ]; then
+        ((argDepth++))
+        if [ "$(help_command "${argDepth}")" = "yes" ]; then
+            help_devices_list
+        fi
+    else
+        echo -e "${RED}ERROR: Invalid argument ${NC}${1}"
+        echo ""
+        echo -e "Use \`qbraid devices -h\` to see available commands"
+        exit 1
+    fi
+}
 
 ############################### CLI ENTRYPOINT ###########################
 #-------------------------------------------------------------------------
@@ -1159,10 +1194,15 @@ help() {
     echo "Group"
     echo "    qbraid"
     echo ""
+    echo "Commands"
+    echo "    configure        : Update or add qbraidrc config values."
+    echo "    credits          : Get number of qBraid credits remaining."
+    echo ""
     echo "Subgroups"
     echo "    envs             : Manage qBraid environments."
     echo "    kernels          : Manage qBraid kernels."
     echo "    jobs             : Manage qBraid Quantum Jobs."
+    echo "    devices          : Manage qBraid Quantum Devices."
     echo ""
     echo "Arguments"
     echo "    -V, --version    : Show version and exit"
@@ -1170,7 +1210,34 @@ help() {
     echo "Global Arguments"
     echo "    -h, --help       : Show this help message and exit."
     echo ""
-    echo "Reference Docs: https://docs.qbraid.com/en/latest/cli/qbraid.html"
+    echo "Reference Docs: https://docs.qbraid.com/projects/cli/en/latest/cli/qbraid.html"
+}
+
+# qbraid configure -h
+help_configure() {
+    echo ""
+    echo "Command"
+    echo "    qbraid configure                 : Update or add qbraidrc config values."
+    echo ""
+    echo "Optional Arguments"
+    echo "    -h, --help                       : Show this help message and exit."
+    echo ""
+    echo "Examples"
+    echo "    $ qbraid configure"
+    echo "    email [None]: contact@qbraid.com"
+    echo "    api-key [None]: 1234567890"
+    echo ""
+}
+
+# qbraid credits -h
+help_credits() {
+    echo ""
+    echo "Command"
+    echo "    qbraid credits    : Get number of qBraid credits remaining." 
+    echo ""
+    echo "Optional Arguments"
+    echo "    -h, --help        : Show this help message and exit."
+    echo ""
 }
 
 #-------------------------------------------------------------------------
@@ -1186,27 +1253,37 @@ qbraid() {
     
     # qbraid
     elif [ -z "${1}" ]; then
-        echo -e "-------------------------------"
-        echo -e "* ${PURPLE}Welcome to the qBraid CLI!${NC} *"
-        echo -e "-------------------------------"
+        echo -e "---------------------------------"
+        echo -e " * ${PURPLE}Welcome to the qBraid CLI!${NC} * "
+        echo -e "---------------------------------"
+        echo -e ""
+        echo -e "        ____            _     _  " 
+        echo -e "   __ _| __ ) _ __ __ _(_) __| | "
+        echo -e "  / _  |  _ \|  __/ _  | |/ _  | " 
+        echo -e " | (_| | |_) | | | (_| | | (_| | " 
+        echo -e "  \__  |____/|_|  \__ _|_|\__ _| "
+        echo -e "     |_|                         "
         echo -e ""
-        echo -e "  - Use \`qbraid -h\` to see available commands."
         echo -e ""
-        echo -e "  - Use \`qbraid --version\` to display the current version."
+        echo -e "- Use \`qbraid -h\` to see available commands."
+        echo -e ""
+        echo -e "- Use \`qbraid --version\` to display the current version."
         echo -e ""
         echo -e "Reference Docs: https://docs.qbraid.com/projects/cli/en/latest/cli/qbraid.html"
-        
-    elif [ "${1}" = "banner" ]; then
-        bin/banner.sh
-    
-    # qbraid -V (DEPRECATED, now handled by top-level python)
-    elif [ "${1}" = "--version" ] || [ "${1}" = "-V" ]; then
-        # pipversion=$(pip --version | cut -c1-10)
-        # pipversion="${pipversion// //}"
-        # azversion=$(az --version | head -n 1 | xargs)
-        # azversion="${azversion// //}"
-        # awsversion=$(aws --version)
-        echo -e "qbraid-cli/$VERSION"
+
+    # qbraid configure
+    elif [ "${1}" = "configure" ]; then
+        ((argDepth++))
+        if [ "$(help_command "${argDepth}")" = "yes" ]; then
+            help_configure
+        fi
+
+    # qbraid credits
+    elif [ "${1}" = "credits" ]; then
+        ((argDepth++))
+        if [ "$(help_command "${argDepth}")" = "yes" ]; then
+            help_credits
+        fi
 
     # qbraid envs
     elif [ "${1}" = "envs" ]; then
@@ -1220,6 +1297,10 @@ qbraid() {
     elif [ "${1}" = "jobs" ]; then
         jobs "${@:2}"
     
+    # qbraid devices
+    elif [ "${1}" = "devices" ]; then
+        devices "${@:2}"
+
     else
         echo -e "${RED}ERROR: Invalid argument ${NC}${1}"
         echo ""

{qbraid-cli-0.6.1 → qbraid-cli-0.7.0}/qbraid_cli/wrapper.py

@@ -1,6 +1,8 @@
 """
 Module to run the qbraid command line interface.
 
+Lazy loading is used to avoid loading the qbraid package until it is needed.
+
 """
 
 import os
@@ -13,13 +15,51 @@ from .configure import configure
 PROJECT_ROOT = os.path.dirname(os.path.abspath(__file__))
 
 
+def flag_help_command():
+    """Check if the help command should be triggered."""
+    if len(sys.argv) > 0:
+        last_arg = sys.argv[-1]
+        if last_arg in ["-h", "--help", "help"]:
+            return True
+    return False
+
+
+def is_help_command(arg_index):
+    """Check if the help command should be triggered for the given argument index"""
+    if flag_help_command() and arg_index == len(sys.argv) - 1:
+        return True
+    return False
+
+
+def get_credits():
+    """Get the number of credits available to the user."""
+    # pylint: disable-next=import-outside-toplevel
+    from qbraid.api import QbraidSession
+
+    session = QbraidSession()
+    res = session.get("/billing/credits/get-user-credits").json()
+    qbraid_credits = res["qbraidCredits"]
+    print(qbraid_credits)
+
+
 def main():
     """The subprocess.run function is used to run the script and pass arguments."""
-
-    if len(sys.argv) > 1 and sys.argv[1] == "configure":
+    if len(sys.argv) == 2 and sys.argv[1] == "configure":
         configure()
+    elif len(sys.argv) == 2 and sys.argv[1] == "credits":
+        get_credits()
     elif sys.argv[1:] == ["--version"] or sys.argv[1:] == ["-V"]:
         print(f"qbraid-cli/{__version__}")
+    elif len(sys.argv) == 3 and sys.argv[1:] == ["jobs", "list"]:
+        # pylint: disable-next=import-outside-toplevel
+        from qbraid import get_jobs
+
+        get_jobs()
+    elif len(sys.argv) == 3 and sys.argv[1:] == ["devices", "list"]:
+        # pylint: disable-next=import-outside-toplevel
+        from qbraid import get_devices
+
+        get_devices()
     else:
         result = subprocess.run(
             [os.path.join(PROJECT_ROOT, "bin", "qbraid.sh")] + sys.argv[1:],

{qbraid-cli-0.6.1 → qbraid-cli-0.7.0}/qbraid_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qbraid-cli
-Version: 0.6.1
+Version: 0.7.0
 Summary: Command Line Interface for interacting with all parts of the qBraid platform.
 Home-page: https://www.qbraid.com/
 Author: qBraid Development Team
@@ -16,14 +16,15 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >= 3.8
 Description-Content-Type: text/markdown
+Requires-Dist: qbraid>=0.5.0
 Requires-Dist: awscli
+Requires-Dist: ipykernel
 Provides-Extra: dev
 Requires-Dist: black; extra == "dev"
 Requires-Dist: isort; extra == "dev"

{qbraid-cli-0.6.1 → qbraid-cli-0.7.0}/qbraid_cli.egg-info/SOURCES.txt

@@ -10,5 +10,4 @@ qbraid_cli.egg-info/dependency_links.txt
 qbraid_cli.egg-info/entry_points.txt
 qbraid_cli.egg-info/requires.txt
 qbraid_cli.egg-info/top_level.txt
-qbraid_cli/bin/banner.sh
 qbraid_cli/bin/qbraid.sh

{qbraid-cli-0.6.1 → qbraid-cli-0.7.0}/qbraid_cli.egg-info/requires.txt

@@ -1,4 +1,6 @@
+qbraid>=0.5.0
 awscli
+ipykernel
 
 [dev]
 black

{qbraid-cli-0.6.1 → qbraid-cli-0.7.0}/setup.py

@@ -48,12 +48,12 @@ setup(
     packages=find_packages(),
     include_package_data=True,
     python_requires=">= 3.8",
-    install_requires=["awscli"],
+    install_requires=["qbraid>=0.5.0", "awscli", "ipykernel"],
     extras_require={
         "dev": ["black", "isort", "pylint"],
         "docs": ["sphinx~=5.3.0", "sphinx-rtd-theme~=1.3.0", "docutils~=0.18.1"],
     },
-    scripts=["qbraid_cli/bin/qbraid.sh", "qbraid_cli/bin/banner.sh"],
+    scripts=["qbraid_cli/bin/qbraid.sh"],
     entry_points={
         "console_scripts": [
             "qbraid=qbraid_cli.wrapper:main",
@@ -68,7 +68,6 @@ setup(
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3 :: Only",
-        "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",

qbraid-cli-0.6.1/qbraid_cli/bin/banner.sh

@@ -1,17 +0,0 @@
-NC="\033[0m" # No Color
-PURPLE="\033[0;35m"
-
-echo -e "---------------------------------------"
-echo -e "* ${PURPLE}Welcome to the qBraid Lab Terminal!${NC} *"
-echo -e "---------------------------------------"
-echo -e ""
-echo -e "        ____            _     _  " 
-echo -e "   __ _| __ ) _ __ __ _(_) __| | "
-echo -e "  / _  |  _ \|  __/ _  | |/ _  | " 
-echo -e " | (_| | |_) | | | (_| | | (_| | " 
-echo -e "  \__  |____/|_|  \__ _|_|\__ _| "
-echo -e "     |_|                         "
-echo -e ""
-echo -e ""
-echo -e "Use \`qbraid -h\` to see available CLI commands."
-echo -e ""