{"library":"openxlab","title":"OpenXLab Python SDK","description":"OpenXLab is a Python library providing tools to interact with the OpenXLab platform, focusing on managing datasets and models. It includes a command-line interface (CLI) and a Python SDK to programmatically access platform features such as dataset information, upload, and download. The library is currently at version 0.1.3 and appears to have a regular release cadence, with updates often reflecting platform-level changes within the broader OpenXLab ecosystem.","language":"python","status":"active","last_verified":"Wed May 13","install":{"commands":["pip install openxlab"],"cli":{"name":"openxlab","version":"usage: openxlab [-h] {version,demo,config,dataset,model,login,token,help} ..."}},"imports":["from openxlab.dataset import get","from openxlab.dataset import upload_folder","from openxlab.xlab.handler.user_token import get_jwt"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import os\nfrom openxlab.xlab.handler.user_token import get_jwt\nfrom openxlab.dataset import get\n\n# Set your Access Key and Secret Key as environment variables\n# These can be obtained from your OpenXLab user center.\n# For example: export OPENXLAB_AK=\"YOUR_AK_HERE\"\n# For example: export OPENXLAB_SK=\"YOUR_SK_HERE\"\nak = os.environ.get('OPENXLAB_AK', 'YOUR_AK_HERE')\nsk = os.environ.get('OPENXLAB_SK', 'YOUR_SK_HERE')\n\nif ak == 'YOUR_AK_HERE' or sk == 'YOUR_SK_HERE':\n    print(\"Please set OPENXLAB_AK and OPENXLAB_SK environment variables or replace placeholders.\")\n    # Attempt to use CLI config if env vars are not set for demonstration purposes\n    # In a real scenario, user would run 'openxlab config' or set env vars.\n    # For programmatic access, env vars are preferred.\nelse:\n    try:\n        # Authenticate and get a JWT token\n        token = get_jwt(ak=ak, sk=sk)\n        print(f\"Successfully obtained JWT token (first 10 chars): {token[:10]}...\")\n\n        # Example: Get (download) a public dataset\n        # Replace 'OpenDataLab/MNIST' with a valid dataset repository and adjust target_path\n        # Ensure the target_path exists or can be created.\n        dataset_repo_name = 'OpenDataLab/MNIST'\n        target_download_path = './MNIST_dataset'\n        print(f\"\\nAttempting to download dataset: {dataset_repo_name} to {target_download_path}\")\n        \n        # Create a dummy directory for download if it doesn't exist\n        os.makedirs(target_download_path, exist_ok=True)\n\n        # Note: The 'get' function might automatically use configured AK/SK,\n        # but explicit authentication often precedes other SDK calls.\n        get(dataset_repo=dataset_repo_name, target_path=target_download_path)\n        print(f\"Dataset '{dataset_repo_name}' downloaded to '{target_download_path}' successfully.\")\n\n    except Exception as e:\n        print(f\"An error occurred: {e}\")\n        print(\"Ensure your AK/SK are correct and you have network access to OpenXLab.\")\n","lang":"python","description":"This quickstart demonstrates how to authenticate with OpenXLab using environment variables for Access Key (AK) and Secret Key (SK), and then how to use the `openxlab.dataset.get` function to download a public dataset. Replace 'YOUR_AK_HERE' and 'YOUR_SK_HERE' with your actual credentials, or ideally, set them as environment variables (OPENXLAB_AK, OPENXLAB_SK). The example attempts to download the 'OpenDataLab/MNIST' dataset, which is a common public dataset.","tag":null,"tag_description":null,"last_tested":"2026-04-24","results":[{"runtime":"python:3.10-alpine","exit_code":0},{"runtime":"python:3.10-slim","exit_code":0},{"runtime":"python:3.11-alpine","exit_code":0},{"runtime":"python:3.11-slim","exit_code":0},{"runtime":"python:3.12-alpine","exit_code":0},{"runtime":"python:3.12-slim","exit_code":0},{"runtime":"python:3.13-alpine","exit_code":0},{"runtime":"python:3.13-slim","exit_code":0},{"runtime":"python:3.9-alpine","exit_code":0},{"runtime":"python:3.9-slim","exit_code":0}]},"compatibility":{"tag":"verified","tag_description":"installs cleanly on critical runtimes, fast import, recently tested","last_tested":"2026-05-13","installed_version":"0.1.3","pypi_latest":"0.1.3","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":100,"avg_install_s":8.8,"avg_import_s":0.89,"wheel_type":"sdist"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"openxlab","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.84,"mem_mb":14.6,"disk_size":"71.2M"},{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"openxlab","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.86,"mem_mb":14.6,"disk_size":"70.1M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"openxlab","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":7.9,"import_time_s":0.66,"mem_mb":14.6,"disk_size":"73M"},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"openxlab","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.72,"mem_mb":14.6,"disk_size":"72M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"openxlab","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":1.03,"mem_mb":16.1,"disk_size":"77.9M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"openxlab","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":1.17,"mem_mb":16.1,"disk_size":"76.8M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"openxlab","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":7.6,"import_time_s":0.91,"mem_mb":16.1,"disk_size":"80M"},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"openxlab","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.93,"mem_mb":16.1,"disk_size":"78M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"openxlab","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.92,"mem_mb":16.3,"disk_size":"73.4M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"openxlab","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":1.02,"mem_mb":16.3,"disk_size":"72.3M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"openxlab","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":10.3,"import_time_s":0.94,"mem_mb":16.3,"disk_size":"75M"},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"openxlab","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":1.04,"mem_mb":16.3,"disk_size":"74M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"openxlab","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.92,"mem_mb":17.3,"disk_size":"73.2M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"openxlab","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.97,"mem_mb":17.3,"disk_size":"72.0M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"openxlab","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":9.3,"import_time_s":0.89,"mem_mb":17.3,"disk_size":"75M"},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"openxlab","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":1.04,"mem_mb":17.3,"disk_size":"74M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"openxlab","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":null,"import_time_s":0.7,"mem_mb":14.3,"disk_size":"71.0M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"openxlab","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.88,"mem_mb":14.3,"disk_size":"69.9M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"openxlab","exit_code":0,"wheel_type":"sdist","failure_reason":null,"import_side_effects":"clean","install_time_s":9,"import_time_s":0.7,"mem_mb":14.3,"disk_size":"73M"},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"openxlab","exit_code":0,"wheel_type":null,"failure_reason":null,"import_side_effects":null,"install_time_s":null,"import_time_s":0.7,"mem_mb":14.3,"disk_size":"71M"}]}}