quantum-random 1.4.0__tar.gz → 1.4.2__tar.gz

quantum_random-1.4.2/.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    permissions:
+      id-token: write
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "0.5.4"
+      - name: Build
+        run: uv build
+      - name: Publish
+        run: uv publish

quantum_random-1.4.2/.github/workflows/tests.yml

@@ -0,0 +1,51 @@
+name: Tests
+
+on: push
+
+jobs:
+  test:
+    name: Tests and type checks
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "0.5.4"
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+      - name: Install the project
+        run: uv sync --all-extras --dev
+      - name: Run pytest
+        run: QRANDOM_API_KEY=key uv run pytest
+      - name: Run mypy
+        run: uv run mypy --install-types --non-interactive .
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "0.5.4"
+      - name: Set up Python
+        run: uv python install
+      - name: Install the project
+        run: uv sync --all-extras --dev
+      - name: Run black
+        run: uv run black --check .
+      - name: Run isort
+        run: uv run isort --check .
+      - name: Run flake8
+        run: uv run flake8 --extend-exclude .venv

quantum_random-1.4.2/.gitignore

@@ -0,0 +1,3 @@
+*.pyc
+dist/
+*.egg-info/

quantum_random-1.4.2/.python-version

@@ -0,0 +1 @@
+3.12

{quantum_random-1.4.0 → quantum_random-1.4.2}/PKG-INFO

@@ -1,15 +1,13 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: quantum-random
-Version: 1.4.0
+Version: 1.4.2
 Summary: Quantum random numbers
-Home-page: https://github.com/sbalian/quantum-random/
-License: MIT
+Project-URL: Homepage, https://github.com/sbalian/quantum-random
+Project-URL: Repository, https://github.com/sbalian/quantum-random
+Author-email: Seto Balian <seto.balian@gmail.com>
+Maintainer-email: Seto Balian <seto.balian@gmail.com>
+License: MIT License
 Keywords: quantum,random,statistics
-Author: Seto Balian
-Author-email: seto.balian@gmail.com
-Maintainer: Seto Balian
-Maintainer-email: seto.balian@gmail.com
-Requires-Python: >=3.9,<4.0
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License
@@ -18,20 +16,16 @@ Classifier: Operating System :: Microsoft :: Windows
 Classifier: Operating System :: Unix
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development
 Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: click>=8.1.7
+Requires-Dist: requests>=2.32.3
+Requires-Dist: xdg>=6.0.0
 Provides-Extra: numpy
-Requires-Dist: click (>=8.1.7,<9.0.0)
-Requires-Dist: numpy (>=1.26.4,<2.0.0) ; extra == "numpy"
-Requires-Dist: randomgen (>=1.26.1,<2.0.0) ; extra == "numpy"
-Requires-Dist: requests (>=2.31.0,<3.0.0)
-Requires-Dist: xdg (>=6.0.0,<7.0.0)
-Project-URL: Repository, https://github.com/sbalian/quantum-random/
+Requires-Dist: numpy>=2.0.2; extra == 'numpy'
+Requires-Dist: randomgen>=2.1.1; extra == 'numpy'
 Description-Content-Type: text/markdown
 
 # Quantum random numbers in Python
@@ -125,7 +119,7 @@ if you need to pre-fetch at the start of your computation.
 ## Tests
 
 The tests run for Python 3.9 - 3.12 on the latest Windows,
-macOS and Ubuntu runner images. Use [tox][tox] to run the tests locally.
+macOS and Ubuntu runner images.
 
 See [here](./analysis/uniform.md) for a visualisation and a Kolmogorov–Smirnov
 test.
@@ -150,7 +144,5 @@ See [LICENCE](./LICENSE).
 [anu]: https://quantumnumbers.anu.edu.au
 [anupricing]: https://quantumnumbers.anu.edu.au/pricing
 [pyrandom]: https://docs.python.org/3/library/random.html
-[tox]: https://tox.wiki/en/latest/
 [numpy]: https://numpy.org
 [randomgen]: https://github.com/bashtage/randomgen
-

{quantum_random-1.4.0 → quantum_random-1.4.2}/README.md

@@ -89,7 +89,7 @@ if you need to pre-fetch at the start of your computation.
 ## Tests
 
 The tests run for Python 3.9 - 3.12 on the latest Windows,
-macOS and Ubuntu runner images. Use [tox][tox] to run the tests locally.
+macOS and Ubuntu runner images.
 
 See [here](./analysis/uniform.md) for a visualisation and a Kolmogorov–Smirnov
 test.
@@ -114,6 +114,5 @@ See [LICENCE](./LICENSE).
 [anu]: https://quantumnumbers.anu.edu.au
 [anupricing]: https://quantumnumbers.anu.edu.au/pricing
 [pyrandom]: https://docs.python.org/3/library/random.html
-[tox]: https://tox.wiki/en/latest/
 [numpy]: https://numpy.org
 [randomgen]: https://github.com/bashtage/randomgen

quantum_random-1.4.2/analysis/README.md

@@ -0,0 +1,15 @@
+# Analysis
+
+To run the analysis, first install the requirements (includes `quantum-random`):
+
+```bash
+pip install -r requirements.txt
+```
+
+Then run the script to generate the plot in `uniform.md`:
+
+```bash
+python generate_plot.py
+```
+
+The output is written to `random.png`.

quantum_random-1.4.2/analysis/generate_plot.py

@@ -0,0 +1,53 @@
+import random
+from typing import List, Tuple
+
+import matplotlib.pyplot as plt
+from scipy import stats
+
+import qrandom
+
+DataType = Tuple[Tuple[List[float], str], Tuple[List[float], str]]
+
+
+def generate_data() -> DataType:
+    numbers = [qrandom.random() for _ in range(10000)]
+    py_numbers = [random.random() for _ in range(10000)]
+    return (numbers, "Quantum random"), (py_numbers, "Python pseudo-random")
+
+
+def plot(data: DataType) -> None:
+    quantum, python = data
+    numbers, quantum_title = quantum
+    py_numbers, python_title = python
+
+    plt.figure(figsize=(8, 3))
+    plt.subplot(1, 2, 1)
+    plt.hist(numbers, edgecolor="black")
+    plt.title(quantum_title)
+    plt.subplot(1, 2, 2)
+    plt.hist(py_numbers, edgecolor="black")
+    plt.title(python_title)
+    plt.tight_layout()
+    plt.savefig("random.png", dpi=120, bbox_inches="tight")
+    return
+
+
+def kstest(data: DataType) -> None:
+    quantum, python = data
+    numbers, quantum_title = quantum
+    py_numbers, python_title = python
+
+    print(quantum_title, stats.kstest(numbers, "uniform"))
+    print(python_title, stats.kstest(py_numbers, "uniform"))
+    return
+
+
+def main() -> None:
+    data = generate_data()
+    plot(data)
+    kstest(data)
+    return
+
+
+if __name__ == "__main__":
+    main()

quantum_random-1.4.2/analysis/requirements.txt

@@ -0,0 +1,3 @@
+scipy
+matplotlib
+quantum-random

quantum_random-1.4.2/analysis/uniform.md

@@ -0,0 +1,21 @@
+# Visualise and test if the quantum randoms are uniformly distributed in [0.0, 1)
+
+Calling `qrandom.random()` 10,000 times, and comparing it to `random.random()`:
+
+![Random](./random.png)
+
+The [Kolmogorov–Smirnov statistics][kstest] with the reference distribution
+`scipy.uniform` gives the following results.
+
+| Trial | Quantum statistic | Quantum p-value | Std. statistic | Std. p-value |
+| ----- | ----------------- | --------------- | ---------------| -------------|
+| 1     | 0.01              | 0.2             | 0.005          | 0.9          |
+| 2     | 0.007             | 0.7             | 0.005          | 1.0          |
+| 3     | 0.006             | 0.9             | 0.008          | 0.6          |
+| 4     | 0.01              | 0.3             | 0.008          | 0.5          |
+
+Each trial is a different run of [`scipy.stats.kstest`][scipy-kstest] with
+10,000 numbers. The plot shows the numbers for the last trial.
+
+[kstest]: https://en.wikipedia.org/wiki/Kolmogorov%E2%80%93Smirnov_test
+[scipy-kstest]: https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.kstest.html

quantum_random-1.4.2/pyproject.toml

@@ -0,0 +1,79 @@
+[project]
+name = "quantum-random"
+version = "1.4.2"
+description = "Quantum random numbers"
+readme = "README.md"
+license = {text = "MIT License"}
+authors = [
+    { name = "Seto Balian", email = "seto.balian@gmail.com" }
+]
+maintainers = [
+    { name = "Seto Balian", email = "seto.balian@gmail.com" }
+]
+keywords = ["quantum", "random", "statistics"]
+classifiers = [
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development",
+    "Topic :: Scientific/Engineering",
+    "Typing :: Typed",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: Unix",
+    "Operating System :: MacOS",
+    "License :: OSI Approved :: MIT License",
+]
+requires-python = ">=3.9"
+dependencies = [
+    "click>=8.1.7",
+    "requests>=2.32.3",
+    "xdg>=6.0.0",
+]
+
+[project.optional-dependencies]
+numpy = [
+    "numpy>=2.0.2",
+    "randomgen>=2.1.1",
+]
+
+[dependency-groups]
+dev = [
+    "pytest-mock>=3.14.0",
+    "pytest>=8.3.3",
+    "responses>=0.25.3",
+    "mypy>=1.13.0",
+    "flake8>=7.1.1",
+    "isort>=5.13.2",
+    "black>=24.10.0",
+    "pip>=24.3.1",
+]
+
+[project.scripts]
+qrandom-init = "qrandom._cli:main"
+
+[project.urls]
+Homepage = "https://github.com/sbalian/quantum-random"
+Repository = "https://github.com/sbalian/quantum-random"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/qrandom"]
+
+[tool.pytest.ini_options]
+addopts = "--verbose"
+testpaths = "tests"
+
+[tool.mypy]
+ignore_missing_imports = true
+
+[tool.black]
+line-length = 79
+
+[tool.isort]
+profile = "black"
+line_length = 79
+known_first_party = ["qrandom"]

quantum_random-1.4.2/tests/conftest.py

@@ -0,0 +1,120 @@
+import json
+
+import pytest
+import responses
+
+from qrandom import _api, _generator
+
+
+@pytest.fixture
+def mocked_responses():
+    with responses.RequestsMock() as rsps:
+        yield rsps
+
+
+@pytest.fixture
+def test_responses():
+    with open("tests/data/responses.json") as f:
+        return json.load(f)
+
+
+@pytest.fixture
+def anu_url():
+    return "https://api.quantumnumbers.anu.edu.au"
+
+
+@pytest.fixture
+def api_client_with_successful_api_call(
+    mocked_responses, anu_url, test_responses
+):
+    mocked_responses.get(
+        anu_url,
+        json={"data": test_responses[0]["data"], "success": True},
+        status=200,
+    )
+    return _api.Client("key")
+
+
+@pytest.fixture
+def api_client_with_failed_api_call(mocked_responses, anu_url):
+    mocked_responses.get(
+        anu_url,
+        json={"success": False},
+        status=400,
+    )
+    return _api.Client("key")
+
+
+@pytest.fixture
+def api_client_with_failed_api_call_and_no_json_response(
+    mocked_responses, anu_url
+):
+    mocked_responses.get(
+        anu_url,
+        status=400,
+    )
+    return _api.Client("key")
+
+
+@pytest.fixture
+def api_client_with_failed_api_call_with_200_status(mocked_responses, anu_url):
+    mocked_responses.get(
+        anu_url,
+        json={"success": False},
+        status=200,
+    )
+    return _api.Client("key")
+
+
+@pytest.fixture
+def api_client_with_mocked_fetch_hex_raw(mocker, test_responses):
+    mocker.patch(
+        "qrandom._api.Client.fetch_hex_raw",
+        return_value=test_responses[0],
+    )
+    return _api.Client("key")
+
+
+@pytest.fixture
+def quantum_random_with_no_api_calls():
+    return _generator.QuantumRandom()
+
+
+@pytest.fixture
+def quantum_random_with_mocked_fetch_hex_raw(mocker, test_responses):
+    mocker.patch(
+        "qrandom._api.Client.fetch_hex_raw",
+        return_value=test_responses[0],
+    )
+    return _generator.QuantumRandom()
+
+
+@pytest.fixture
+def quantum_random_with_mocked_fetch_hex_raw_twice(mocker, test_responses):
+    mocker.patch(
+        "qrandom._api.Client.fetch_hex_raw",
+        side_effect=[test_responses[0], test_responses[1]],
+    )
+    return _generator.QuantumRandom()
+
+
+@pytest.fixture
+def quantum_random_with_mocked_fetch_hex_raw_five_times(
+    mocker, test_responses
+):
+    mocker.patch(
+        "qrandom._api.Client.fetch_hex_raw",
+        side_effect=[test_responses[i] for i in range(5)],
+    )
+    return _generator.QuantumRandom()
+
+
+@pytest.fixture
+def quantum_random_with_mocked_fetch_hex_raw_for_all_data(
+    mocker, test_responses
+):
+    mocker.patch(
+        "qrandom._api.Client.fetch_hex_raw",
+        side_effect=test_responses,
+    )
+    return _generator.QuantumRandom()

quantum_random-1.4.2/tests/data/fetch_data.py

@@ -0,0 +1,56 @@
+import json
+import pathlib
+
+import click
+
+from qrandom import _api
+
+
+@click.command()
+@click.option(
+    "--num-hits",
+    "-n",
+    type=int,
+    default=10,
+    show_default=True,
+    help="Number of API calls.",
+)
+@click.option(
+    "--output-directory",
+    "-o",
+    type=click.Path(
+        exists=True,
+        file_okay=False,
+        resolve_path=True,
+        path_type=pathlib.Path,
+    ),
+    default=pathlib.Path("."),
+    help="Output directory.",
+    show_default=True,
+)
+def main(num_hits, output_directory) -> None:
+    """Write a JSON file of responses from the ANU API for testing purposes."""
+
+    output_path = output_directory / "responses.json"
+    if output_path.exists():
+        click.confirm(
+            f"Would you like to overwrite {output_path}?",
+            abort=True,
+        )
+
+    key = _api.find_api_key()
+    client = _api.Client(key)
+
+    click.echo("Fetching data ...")
+    with click.progressbar(range(num_hits)) as bar:
+        responses = [client.fetch_hex_raw() for _ in bar]
+    click.echo("Writing responses ...")
+    with open(pathlib.Path(output_path), "w") as f:
+        json.dump(responses, f)
+    click.echo(f"Wrote responses to {output_path} .")
+
+    return
+
+
+if __name__ == "__main__":
+    main()