Skip to main content

Quantum Challenge Grader

Grading client for the IBM Quantum Challenge grading service.

Requirements

Installation

Install the grading client into your Python environment:

pip install qc-grader

Authentication

The grader authenticates with your IBM Quantum Platform API key. You can provide it in either of two ways.

If you already use QiskitRuntimeService and have saved your account by following the setup instructions, the grader reuses that saved account automatically — no extra configuration needed.

To save your account:

from qiskit_ibm_runtime import QiskitRuntimeService

QiskitRuntimeService.save_account(
    channel="ibm_quantum_platform",
    token="<YOUR_API_KEY>",
    set_as_default=True,
    overwrite=True,
)

Your API key is available on your IBM Quantum Platform account page.

Option 2 — Set the QC_API_KEY environment variable

From a terminal, before launching Jupyter:

export QC_API_KEY=your_api_key

Alternatively, run this at the top of a notebook (re-run whenever you start/restart the kernel):

%set_env QC_API_KEY=your_api_key

Note: You can confirm the environment variable is set by running the following in a notebook cell:

import os
print(os.getenv("QC_API_KEY"))

Usage

  1. Open an exercise notebook for the challenge you are participating in.

  2. Run the notebook cells, completing the exercises. Each exercise has a grading function that you import and call with your solution. Grading functions follow the pattern grade_<module>_ex<n> and live under qc_grader.challenges.<challenge>. For example:

    from qc_grader.challenges.<challenge> import grade_<module>_ex1
    
    grade_<module>_ex1(answer_1)
    

    Replace <challenge> with the challenge you are working on (e.g. fallfest_2026, qgss_2026), and <module>/ex<n> with the exercise you are submitting. The specific imports are given in each notebook.

  3. To review how many exercises you have completed so far, use the check_progress helper exposed by each challenge:

    from qc_grader.challenges.<challenge> import check_progress
    
    check_progress()
    

Contributing

See CONTRIBUTING.md for development setup (uv, just), linting, tests, and the release process.

Metadata

Release files for qc-grader 2026.11.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qc-grader 2026.11.3
File Size Uploaded Provenance Actions
qc_grader-2026.11.3.tar.gz 275.3 kB With provenance Details for qc_grader-2026.11.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for qc-grader 2026.11.3
File Interpreter ABI Platform Actions
qc_grader-2026.11.3-py3-none-any.whl Python 3 none any Details for qc_grader-2026.11.3-py3-none-any.whl

Total release size: 454.5 kB

Release files / qc_grader-2026.11.3.tar.gz

Download URL qc_grader-2026.11.3.tar.gz
Size 275.3 kB
Tags Source
SHA-256 checksum
How to use checksums
f5953ff2f195793e590abb12c361d2504fce38deadbec6e014fcf888481dde8b
BLAKE2b-256 checksum
How to use checksums
d5ffd8bf223a4337de806f58a425a5c8b127a01f9303c8d08ba2fd5a6e3c89b1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 3, 2026.

Transparency log

Release files / qc_grader-2026.11.3-py3-none-any.whl

Download URL qc_grader-2026.11.3-py3-none-any.whl
Size 179.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c18a44af2ca6b079d0c6790e6f922fe62c621cb0f8c5236b63edb34191dea542
BLAKE2b-256 checksum
How to use checksums
481cfa689d0a91cfa4b53a59e1fc61d8cbc37ae981cd569c94df6b37bd72c6d5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 3, 2026.

Transparency log

Security for qc-grader 2026.11.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for qc_grader-2026.11.3.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 3, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page