qfest-grader 0.1.2__tar.gz

qfest_grader-0.1.2/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

qfest_grader-0.1.2/NOTICE

@@ -0,0 +1,15 @@
+qfest-grader
+Copyright 2026 Qiskit Fall Fest 2026 Warsaw organisers
+
+This product is derived from the Quantum Challenge Grader (qc-grader 2026.9.29),
+https://github.com/qiskit-community/Quantum-Challenge-Grader
+Copyright 2019 IBM and its contributors, licensed under the Apache License, Version 2.0.
+
+Changes from the original:
+- Answers are reduced to final values (counts, numbers, sparse amplitudes,
+  circuit depth and gate positions, stabilizer expectation values) on the client.
+- Participants are identified by a saved email instead of an IBM Quantum API key.
+- Submissions go to the Warsaw grading server instead of IBM's grading API.
+- Only the Warsaw Lab 0 and Lab 1 grading functions are included.
+
+Files derived from the original keep IBM's copyright notice and state the changes.

qfest_grader-0.1.2/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: qfest-grader
+Version: 0.1.2
+Summary: Grader client for the Qiskit Fall Fest 2026 Warsaw lab notebooks
+License-Expression: Apache-2.0
+Project-URL: Source, https://github.com/wolfomania/qfest-grader
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy>=1.21
+Requires-Dist: qiskit>=1.0
+Requires-Dist: requests>=2.25
+Provides-Extra: test
+Requires-Dist: pytest>=7; extra == "test"
+Dynamic: license-file
+
+# qfest-grader
+
+Grader client for the Qiskit Fall Fest 2026 Warsaw lab notebooks. It checks your lab answers and records which exercises you completed. The organisers issue participation certificates from these records.
+
+## Install
+
+Run in a notebook cell (Google Colab, Jupyter or VS Code), then restart the kernel:
+
+```python
+%pip install -q qfest-grader
+```
+
+The install needs Python 3.9 or later. Update an existing install with `%pip install -U qfest-grader`.
+
+## Use
+
+Save the email you registered with. Run this once per environment; a new Colab session needs it again:
+
+```python
+from qfest_grader import save_account
+save_account("<your email>")
+```
+
+Grade an exercise and check your progress:
+
+```python
+from qfest_grader.challenges.warsaw_2026 import check_progress, grade_lab0_ex2
+
+grade_lab0_ex2(counts)
+check_progress("lab0")
+```
+
+Without a saved account, the grader reads the `QFEST_EMAIL` environment variable.
+
+## What is sent
+
+Each grade call sends your email and a small summary of your answer to the grading server:
+
+- counts, numbers and dictionaries as they are;
+- statevectors as their non-zero amplitudes;
+- circuits as their qubit count, depth, the qubits of each multi-qubit gate and their final state.
+
+Circuit source code and notebook contents are never sent. The email is stored in `~/.qfest/grader.json`, readable only by you.
+
+## Develop
+
+```bash
+pip install -e ".[test]"
+pytest
+```
+
+Releases go to [PyPI](https://pypi.org/project/qfest-grader/) from GitHub Actions: set the same version in `pyproject.toml` and `qfest_grader/__init__.py`, push, then push the tag `v<version>`.
+
+## Licence
+
+Apache License 2.0. Derived from IBM's [Quantum Challenge Grader](https://github.com/qiskit-community/Quantum-Challenge-Grader); see `NOTICE`.

qfest_grader-0.1.2/README.md

@@ -0,0 +1,56 @@
+# qfest-grader
+
+Grader client for the Qiskit Fall Fest 2026 Warsaw lab notebooks. It checks your lab answers and records which exercises you completed. The organisers issue participation certificates from these records.
+
+## Install
+
+Run in a notebook cell (Google Colab, Jupyter or VS Code), then restart the kernel:
+
+```python
+%pip install -q qfest-grader
+```
+
+The install needs Python 3.9 or later. Update an existing install with `%pip install -U qfest-grader`.
+
+## Use
+
+Save the email you registered with. Run this once per environment; a new Colab session needs it again:
+
+```python
+from qfest_grader import save_account
+save_account("<your email>")
+```
+
+Grade an exercise and check your progress:
+
+```python
+from qfest_grader.challenges.warsaw_2026 import check_progress, grade_lab0_ex2
+
+grade_lab0_ex2(counts)
+check_progress("lab0")
+```
+
+Without a saved account, the grader reads the `QFEST_EMAIL` environment variable.
+
+## What is sent
+
+Each grade call sends your email and a small summary of your answer to the grading server:
+
+- counts, numbers and dictionaries as they are;
+- statevectors as their non-zero amplitudes;
+- circuits as their qubit count, depth, the qubits of each multi-qubit gate and their final state.
+
+Circuit source code and notebook contents are never sent. The email is stored in `~/.qfest/grader.json`, readable only by you.
+
+## Develop
+
+```bash
+pip install -e ".[test]"
+pytest
+```
+
+Releases go to [PyPI](https://pypi.org/project/qfest-grader/) from GitHub Actions: set the same version in `pyproject.toml` and `qfest_grader/__init__.py`, push, then push the tag `v<version>`.
+
+## Licence
+
+Apache License 2.0. Derived from IBM's [Quantum Challenge Grader](https://github.com/qiskit-community/Quantum-Challenge-Grader); see `NOTICE`.

qfest_grader-0.1.2/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "qfest-grader"
+version = "0.1.2"
+description = "Grader client for the Qiskit Fall Fest 2026 Warsaw lab notebooks"
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
+requires-python = ">=3.9"
+dependencies = [
+    "numpy>=1.21",
+    "qiskit>=1.0",
+    "requests>=2.25",
+]
+
+[project.optional-dependencies]
+test = ["pytest>=7"]
+
+[project.urls]
+Source = "https://github.com/wolfomania/qfest-grader"
+
+[tool.setuptools.packages.find]
+include = ["qfest_grader*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

qfest_grader-0.1.2/qfest_grader/__init__.py

@@ -0,0 +1,22 @@
+# Copyright 2026 Qiskit Fall Fest 2026 Warsaw organisers.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+
+"""Grader client for the Qiskit Fall Fest 2026 Warsaw lab notebooks.
+
+Set up once per environment::
+
+    from qfest_grader import save_account
+    save_account("<your email>")
+
+Then call the ``grade_labN_exM`` functions from ``qfest_grader.challenges.warsaw_2026``.
+"""
+
+__version__ = "0.1.2"
+
+from qfest_grader.account import AccountError, save_account, saved_email  # noqa: E402
+from qfest_grader.challenges.warsaw_2026 import check_progress  # noqa: E402
+
+__all__ = ["AccountError", "__version__", "check_progress", "save_account", "saved_email"]

qfest_grader-0.1.2/qfest_grader/account.py

@@ -0,0 +1,127 @@
+# Copyright 2026 Qiskit Fall Fest 2026 Warsaw organisers.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+
+"""Participant identity: the email saved once per environment."""
+
+from __future__ import annotations
+
+import json
+import os
+import re
+import tempfile
+from datetime import datetime, timezone
+from pathlib import Path
+from typing import Optional
+
+CONFIG_DIR_ENV = "QFEST_CONFIG_DIR"
+EMAIL_ENV = "QFEST_EMAIL"
+CONFIG_FILE = "grader.json"
+
+_EMAIL_RE = re.compile(r"^[^@\s]+@[^@\s]+\.[^@\s]+$")
+_PLACEHOLDER_DOMAINS = ("example.com", "example.org", "example.net")
+
+
+class AccountError(ValueError):
+    """The grader email is missing or invalid."""
+
+
+def normalize_email(email: object) -> str:
+    """Return the email trimmed and lower-cased, or raise AccountError."""
+    if not isinstance(email, str):
+        raise AccountError('Pass your email as text: save_account("<your email>").')
+    normalized = email.strip().lower()
+    if len(normalized) > 254 or not _EMAIL_RE.match(normalized):
+        raise AccountError(f"{email!r} does not look like an email address.")
+    if normalized.rsplit("@", 1)[1] in _PLACEHOLDER_DOMAINS:
+        raise AccountError("Replace the placeholder with the email you registered with.")
+    return normalized
+
+
+def config_path() -> Path:
+    base = os.environ.get(CONFIG_DIR_ENV)
+    directory = Path(base) if base else Path.home() / ".qfest"
+    return directory / CONFIG_FILE
+
+
+def _write_private_json(path: Path, data: dict) -> None:
+    """Write JSON readable only by the owner, replacing the file atomically."""
+    path.parent.mkdir(parents=True, exist_ok=True)
+    fd, tmp_name = tempfile.mkstemp(dir=path.parent, prefix=".grader-", suffix=".json")
+    try:
+        with os.fdopen(fd, "w", encoding="utf-8") as handle:
+            json.dump(data, handle)
+        os.chmod(tmp_name, 0o600)
+        os.replace(tmp_name, path)
+    except BaseException:
+        if os.path.exists(tmp_name):
+            os.remove(tmp_name)
+        raise
+
+
+def saved_email() -> Optional[str]:
+    """The saved email, else the QFEST_EMAIL environment variable, else None."""
+    path = config_path()
+    if path.is_file():
+        try:
+            email = json.loads(path.read_text(encoding="utf-8")).get("email")
+            return normalize_email(email)
+        except (OSError, ValueError, AttributeError):
+            pass
+    env_email = os.environ.get(EMAIL_ENV)
+    if env_email:
+        try:
+            return normalize_email(env_email)
+        except AccountError:
+            return None
+    return None
+
+
+def require_email() -> str:
+    email = saved_email()
+    if email is None:
+        raise AccountError(
+            'No grader account found. Run save_account("<your email>") with the email '
+            "you registered with, then run this cell again."
+        )
+    return email
+
+
+def save_account(email: str, verify: bool = True) -> None:
+    """Save the email that identifies your submissions. Run once per environment.
+
+    Args:
+        email: The email you registered for Qiskit Fall Fest 2026 Warsaw.
+        verify: Also register the email with the grading server (default True).
+    """
+    normalized = normalize_email(email)
+    _write_private_json(
+        config_path(),
+        {"email": normalized, "saved_at": datetime.now(timezone.utc).isoformat(timespec="seconds")},
+    )
+    if not verify:
+        print(f"Grader account saved for {normalized}.")
+        return
+
+    from qfest_grader.api import GraderError, call_rpc
+
+    try:
+        response = call_rpc("qf_register", {"p_email": normalized, "p_client": _client_tag()})
+    except GraderError as err:
+        print(f"Grader account saved for {normalized}, but the server check failed: {err}")
+        return
+    if isinstance(response, dict) and response.get("ok"):
+        print(f"{response.get('msg', 'Grader account saved.')} ✅")
+    else:
+        message = response.get("msg") if isinstance(response, dict) else response
+        print(f"Grader account saved for {normalized}, but the server replied: {message}")
+
+
+def _client_tag() -> str:
+    import platform
+
+    from qfest_grader import __version__
+
+    return f"qfest-grader/{__version__} python/{platform.python_version()}"