randomness-kit 0.1.0__tar.gz → 0.1.2__tar.gz

{randomness_kit-0.1.0 → randomness_kit-0.1.2}/Cargo.lock

@@ -537,7 +537,7 @@ checksum = "63b8176103e19a2643978565ca18b50549f6101881c443590420e4dc998a3c69"
 
 [[package]]
 name = "randomness-kit"
-version = "0.1.0"
+version = "0.1.2"
 dependencies = [
  "cjk",
  "libsodium-rs",

{randomness_kit-0.1.0 → randomness_kit-0.1.2}/Cargo.toml

@@ -1,17 +1,19 @@
 [package]
 name = "randomness-kit"
-version = "0.1.0"
+description = "some tools about randomness calculation"
+repository = "https://github.com/sb-child/randomness-kit"
+version = "0.1.2"
 edition = "2024"
 license = "MIT"
 authors = ["sbchild <sbchild0@gmail.com>"]
 readme = "README.md"
 
 [lib]
-name = "randomness_kit"
+name = "_randomness_kit"
 crate-type = ["cdylib"]
 
 [dependencies]
-pyo3 = "0.29.2"
+pyo3 = { version = "0.29.2" }
 secrets = { git = "https://github.com/sb-child/secrets-rs", rev = "2bf8870156a8115fd7b71aa8cd620088521a5104", features = [
     "use-libsodium-sys",
 ] }
@@ -30,4 +32,4 @@ codegen-units = 1
 lto = true
 opt-level = 3
 panic = 'abort'
-strip = true
+strip = 'debuginfo' # otherwise PyO3 can't introspect the library to generate type stubs

{randomness_kit-0.1.0 → randomness_kit-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: randomness-kit
-Version: 0.1.0
+Version: 0.1.2
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
@@ -30,7 +30,7 @@ uv tool install maturin
 Build debug package, and install in local venv:
 
 ```bash
-maturin develop --uv
+uv run dev.py
 uv run python3
 ```
 
@@ -44,12 +44,13 @@ ls dist  # whl file generates here
 Commit a release:
 
 ```bash
+# Bump version at Cargo.toml
 uv run release.py
 ```
 
 Generate CI config:
 
 ```bash
-maturin generate-ci github > .github/workflows/CI.yml
+uv run gen-ci.py
 ```
 

{randomness_kit-0.1.0 → randomness_kit-0.1.2}/README.md

@@ -17,7 +17,7 @@ uv tool install maturin
 Build debug package, and install in local venv:
 
 ```bash
-maturin develop --uv
+uv run dev.py
 uv run python3
 ```
 
@@ -31,11 +31,12 @@ ls dist  # whl file generates here
 Commit a release:
 
 ```bash
+# Bump version at Cargo.toml
 uv run release.py
 ```
 
 Generate CI config:
 
 ```bash
-maturin generate-ci github > .github/workflows/CI.yml
+uv run gen-ci.py
 ```

randomness_kit-0.1.2/builder_cb.py

@@ -0,0 +1,64 @@
+import subprocess
+import maturin
+from pathlib import Path
+from typing import Any, Mapping
+
+SCRIPT_DIR = Path(__file__).resolve().parent
+
+
+def add_settings(
+    s: Mapping[str, Any] | None = None, stubs: bool = True, release: bool = False
+) -> Mapping[str, Any]:
+    args = []
+    if stubs:
+        args.append("--generate-stubs")
+    if release:
+        args.append("--release")
+    base = dict(s) if s else {}
+    return base | {"maturin.build-args": args}
+
+
+def build_wheel(wheel_directory, config_settings=None, metadata_directory=None):
+    return maturin.build_wheel(
+        wheel_directory,
+        # stubs should be generated before build_wheel.
+        add_settings(config_settings, release=False, stubs=False),
+        metadata_directory,
+    )
+
+
+def build_sdist(sdist_directory, config_settings=None):
+    # generate stubs here
+    command = ["maturin", "generate-stubs", "-o", SCRIPT_DIR / "randomness_kit"]
+    subprocess.run(command, env=maturin._get_env(), cwd=SCRIPT_DIR, check=True)
+    return maturin.build_sdist(
+        sdist_directory, add_settings(config_settings, release=True)
+    )
+
+
+def build_editable(wheel_directory, config_settings=None, metadata_directory=None):
+    return maturin.build_editable(
+        wheel_directory, add_settings(config_settings), metadata_directory
+    )
+
+
+def get_requires_for_build_wheel(config_settings=None):
+    return maturin.get_requires_for_build_wheel(
+        add_settings(add_settings(config_settings, release=True), release=True)
+    )
+
+
+def get_requires_for_build_editable(config_settings=None):
+    return maturin.get_requires_for_build_editable(add_settings(config_settings))
+
+
+def prepare_metadata_for_build_wheel(metadata_directory, config_settings=None):
+    return maturin.prepare_metadata_for_build_wheel(
+        metadata_directory, add_settings(config_settings, release=True)
+    )
+
+
+def prepare_metadata_for_build_editable(metadata_directory, config_settings=None):
+    return maturin.prepare_metadata_for_build_editable(
+        metadata_directory, add_settings(config_settings)
+    )

randomness_kit-0.1.2/dev.py

@@ -0,0 +1,61 @@
+#!/usr/bin/env python3
+import argparse
+from pathlib import Path
+import subprocess
+import sys
+
+SCRIPT_DIR = Path(__file__).resolve().parent
+
+
+def generate_stub():
+    command = ["maturin", "generate-stubs", "-o", SCRIPT_DIR / "randomness_kit"]
+    try:
+        subprocess.run(command, cwd=SCRIPT_DIR, check=True)
+    except KeyboardInterrupt:
+        sys.exit(130)
+    except FileNotFoundError:
+        print(
+            "Error: maturin is not installed.",
+            file=sys.stderr,
+        )
+        sys.exit(1)
+
+
+def main():
+    parser = argparse.ArgumentParser(description="`maturin develop` 的快捷封装脚本")
+    group = parser.add_mutually_exclusive_group()
+    group.add_argument(
+        "-d",
+        "--debug",
+        action="store_true",
+        help="以 Debug 模式运行（默认行为）",
+    )
+    group.add_argument(
+        "-r",
+        "--release",
+        action="store_true",
+        help="以 Release 模式运行 (--release)",
+    )
+    args, extra_args = parser.parse_known_args()
+    cmd = ["maturin", "develop", "--uv", "--generate-stubs"]
+    if args.release:
+        cmd.append("--release")
+    cmd.extend(extra_args)
+    print("Generating Stubs...\n")
+    generate_stub()
+    print(f"Execute: {' '.join(cmd)}\n")
+    try:
+        result = subprocess.run(cmd, cwd=SCRIPT_DIR)
+        sys.exit(result.returncode)
+    except KeyboardInterrupt:
+        sys.exit(130)
+    except FileNotFoundError:
+        print(
+            "Error: maturin is not installed.",
+            file=sys.stderr,
+        )
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

randomness_kit-0.1.2/gen-ci.py

@@ -0,0 +1,43 @@
+from pathlib import Path
+import subprocess
+import sys
+
+SCRIPT_DIR = Path(__file__).resolve().parent
+
+
+def gen_ci() -> str:
+    try:
+        p = subprocess.run(
+            ["maturin", "generate-ci", "github"],
+            capture_output=True,
+            check=True,
+            text=True,
+            cwd=SCRIPT_DIR,
+        )
+        ci_file: str = p.stdout
+        return ci_file
+    except FileNotFoundError:
+        sys.exit("Error: maturin is not installed.")
+    except subprocess.CalledProcessError as e:
+        print(e.stderr)
+        sys.exit(f"Generate CI failed: {e}")
+
+
+def write_ci(s: str):
+    ci_path = SCRIPT_DIR / ".github" / "workflows"
+    ci_path.mkdir(parents=True, exist_ok=True)
+    ci_file_path = ci_path / "CI.yml"
+    with open(ci_file_path, "w") as f:
+        f.write(s)
+
+
+def main():
+    print("Generating...")
+    s = gen_ci()
+    print("Saving CI file...")
+    write_ci(s)
+    print("Completed")
+
+
+if __name__ == "__main__":
+    main()

{randomness_kit-0.1.0 → randomness_kit-0.1.2}/pyproject.toml

@@ -1,6 +1,7 @@
 [build-system]
 requires = ["maturin>=1.14,<2.0"]
-build-backend = "maturin"
+build-backend = "builder_cb"
+backend-path = ["."]
 
 [project]
 name = "randomness-kit"
@@ -18,12 +19,16 @@ authors = [{ "name" = "sbchild", "email" = "sbchild0@gmail.com" }]
 license = { file = "LICENSE" }
 
 [tool.maturin]
+module-name = "randomness_kit._randomness_kit"
 features = ["pyo3/extension-module", "pyo3/experimental-inspect"]
+include = ["py.typed"]
 
 [tool.maturin.generate-ci.github]
 # Finally found: https://github.com/PyO3/maturin/blob/main/src/pyproject_toml.rs#L487
-linux = { "targets" = ["x86_64"] }
-musllinux = { "targets" = ["x86_64"] }
+# but before_script_linux doesn't work
+linux = { target = [{ arch = "x86_64", before_script_linux = "xxx" }] }
+musllinux = { target = [{ arch = "x86_64", before_script_linux = "xxx" }] }
+# args = "--generate-stubs" # stubs already exist 
 # windows = {}
 # macos = {}
 # emscripten = {}

randomness_kit-0.1.2/randomness_kit/__init__.py

@@ -0,0 +1,6 @@
+from ._randomness_kit import __all__ as all_modules
+from ._randomness_kit import __doc__ as doc
+from ._randomness_kit import *  # pyright: ignore[reportMissingImports] # noqa: F403
+
+__all__ = all_modules  # pyright: ignore[reportUnsupportedDunderAll]
+__doc__ = doc

randomness_kit-0.1.2/randomness_kit/_randomness_kit/__init__.pyi

@@ -0,0 +1,17 @@
+"""
+`randomness_kit` root module
+"""
+
+from _typeshed import Incomplete
+
+def ping(x: int) -> int:
+    """
+    test function
+    """
+
+def version() -> str:
+    """
+    package version
+    """
+
+def __getattr__(name: str) -> Incomplete: ...

randomness_kit-0.1.2/randomness_kit/_randomness_kit/min_entropy_algo.pyi

@@ -0,0 +1,14 @@
+"""
+Min entropy algorithm module
+"""
+
+from collections.abc import Sequence
+
+def measure_entropy(data: str |Sequence[int]) -> float:
+    """
+    计算数据的最小熵 (Min-entropy: H_infinity).
+    
+    最小熵表示预测最可能出现的字节所需的比特数：`H_inf = -log2(max(P))`.
+    
+    返回值：通常在 `0.0..=8.0` bits 之间。若数据为空则返回 `0.0`。
+    """

randomness_kit-0.1.2/randomness_kit/_randomness_kit/shannon_entropy_algo.pyi

@@ -0,0 +1,32 @@
+"""
+Shannon entropy algorithm module
+"""
+
+from collections.abc import Sequence
+
+def measure_entropy(data: str |Sequence[int]) -> float:
+    """
+    计算数据的香农熵 (Shannon entropy).
+    
+    衡量数据的随机性/信息密度：`H = -sum(p * log2(p))`.
+    
+    返回值：通常在 `0.0..=8.0` bits 之间。若数据为空则返回 `0.0`。
+    """
+
+def measure_metric_entropy(data: str |Sequence[int]) -> float:
+    """
+    计算标准的度量香农熵 (Metric Shannon entropy).
+    
+    将香农熵按 `8-bit` 最大 theoretical 熵 (`8.0` bits) 进行归一化。
+    
+    返回值：通常在 `0.0..=1.0` 之间。
+    """
+
+def measure_normalized_metric_entropy(data: str |Sequence[int]) -> float:
+    """
+    规范化缩放的香农熵 (Normalized Shannon entropy)。
+    
+    完全随机数据的返回值紧密分布在 `1.0` 周围。
+    
+    返回值：通常在 `0.0..=1.0` 之间。有些故意编写的数据会导致结果超过 `1.0`。
+    """

{randomness_kit-0.1.0 → randomness_kit-0.1.2}/release.py

@@ -46,10 +46,11 @@ def main():
     current_branch = run_git("branch", "--show-current", capture=True)
     if not current_branch:
         sys.exit("Error: Not on a valid branch (detached HEAD).")
-    print("\nAdding files...")
+    print()
+    print("Adding files...")
     run_git("add", ".")
     print("Commiting...")
-    run_git("commit", "-am", f"Release {tag}")
+    run_git("commit", "--allow-empty", "-am", f"Release {tag}")
     print("Tagging...")
     run_git("tag", "-a", tag, "-m", f"Version {version}")
     print("Pushing branch...")

{randomness_kit-0.1.0 → randomness_kit-0.1.2}/src/lib.rs

@@ -4,7 +4,8 @@ mod pytypes;
 mod shannon_entropy;
 mod util;
 
-#[pymodule(name = "randomness_kit")]
+/// `randomness_kit` root module
+#[pymodule(name = "_randomness_kit")]
 mod randomness_kit {
     use pyo3::prelude::*;
 
@@ -14,11 +15,19 @@ mod randomness_kit {
     #[pymodule_export]
     use super::min_entropy_algo;
 
+    /// test function
     #[pyfunction]
     fn ping(x: usize) -> usize {
         x * 2
     }
 
+    /// package version
+    #[pyfunction]
+    fn version() -> PyResult<String> {
+        let v = env!("CARGO_PKG_VERSION");
+        Ok(v.to_owned())
+    }
+
     #[pymodule_init]
     fn init(_m: &Bound<'_, PyModule>) -> PyResult<()> {
         // m.add("double2", m.getattr("double")?)