orng 0.1.0a1__tar.gz

orng-0.1.0a1/.github/workflows/lint.yml

@@ -0,0 +1,35 @@
+name: Lint
+
+on:
+  push:
+    branches: [ main, release* ]
+  pull_request:
+    branches: [ main, release* ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
+        with:
+          version: "0.14.x"
+          args: 'format --check'
+  mypy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: "pip"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install . "mypy>=1.10"
+      - name: Type check
+        run: mypy

orng-0.1.0a1/.github/workflows/publish.yml

@@ -0,0 +1,47 @@
+name: Publish Python distribution to PyPI
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  pypi-publish:
+    name: Upload release to PyPI
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

orng-0.1.0a1/.github/workflows/tests.yml

@@ -0,0 +1,37 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main, release* ]
+  pull_request:
+    branches: [ main, release* ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    name: Python ${{ matrix.python-version }} (${{ matrix.os }})
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [Ubuntu]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    runs-on: ${{ matrix.os }}-latest
+
+    steps:
+    - name: Checkout repository and submodules
+      uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e . --group test
+    - name: Test with pytest
+      run: |
+        python -m pytest

orng-0.1.0a1/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

orng-0.1.0a1/.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.4.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.14.2
+  hooks:
+    # Run the linter.
+    - id: ruff
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
+-   repo: https://github.com/codespell-project/codespell
+    rev: v2.2.4
+    hooks:
+      - id: codespell
+        additional_dependencies:
+        - tomli
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.10.0
+    hooks:
+      - id: mypy

orng-0.1.0a1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Michael J. Williams, Christian Chapman-Bird
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

orng-0.1.0a1/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.4
+Name: orng
+Version: 0.1.0a1
+Summary: Omni RNG: A unified, cross-backend random number generator built on the Array API standard.
+Author: Michael J. Williams, Christian Chapman-Bird
+License: MIT License
+        
+        Copyright (c) 2025 Michael J. Williams, Christian Chapman-Bird
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/sequince-dev/orng
+Project-URL: Repository, https://github.com/sequince-dev/orng
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: numpy
+Requires-Dist: numpy>=1.22; extra == "numpy"
+Provides-Extra: torch
+Requires-Dist: torch>=2.0; extra == "torch"
+Provides-Extra: cupy
+Requires-Dist: cupy>=12.0; extra == "cupy"
+Provides-Extra: jax
+Requires-Dist: jax>=0.4; extra == "jax"
+Dynamic: license-file
+
+# Omni RNG (`orng`)
+
+`orng` provides a thin facade over several Array API–compatible random number
+generators. It mirrors the subset of the `numpy.random.Generator` API:
+
+- `random`
+- `uniform`
+- `normal`
+- `choice`
+
+letting you pick the underlying backend at runtime. The following backends are
+currently supported:
+
+- `numpy`
+- `torch`
+- `cupy`
+- `jax`
+
+## Installation
+
+The core package only depends on the standard Python library:
+
+```bash
+pip install orng
+```
+
+Backends are optional extras that you can install on demand:
+
+```bash
+pip install "orng[numpy]"   # NumPy RNG support
+pip install "orng[torch]"   # PyTorch RNG support
+pip install "orng[cupy]"    # CuPy RNG support
+pip install "orng[jax]"     # JAX RNG support
+```
+
+You can also combine extras, e.g. `pip install "orng[numpy,torch]"`.
+
+## Quick Start
+
+```python
+from orng import ArrayRNG
+
+rng = ArrayRNG(backend="numpy", seed=42)
+samples = rng.normal(loc=0.0, scale=1.0, size=5)
+uniform = rng.uniform(low=-1.0, high=1.0, size=(2, 2))
+```
+
+The backend module is imported lazily. If the requested library is missing,
+`ArrayRNG` will raise an informative `ImportError` that points to the matching
+extra.
+
+### Backend State Reference
+
+When you pass the optional `generator` argument to `ArrayRNG`, the expected
+object depends on the backend:
+
+| Backend | Generator argument |
+|---------|--------------------|
+| `numpy` | `numpy.random.Generator` |
+| `torch` | `torch.Generator` |
+| `cupy`  | `cupy.random.Generator` |
+| `jax`   | `jax.random.KeyArray` (from `jax.random.key`) |
+
+This lets you wrap an existing RNG/key instead of seeding a new one.
+
+## Project Layout
+
+```
+orng/
+├── src/orng/
+│   ├── __init__.py      # package exports
+│   ├── _utils.py        # shared helpers (internal)
+│   ├── orng.py          # ArrayRNG facade
+│   └── backends/        # backend-specific implementations
+└── README.md
+```
+
+Each backend class lives in its own module under `orng/backends/`, keeping the
+core facade compact and making optional dependencies easy to manage.

orng-0.1.0a1/README.md

@@ -0,0 +1,79 @@
+# Omni RNG (`orng`)
+
+`orng` provides a thin facade over several Array API–compatible random number
+generators. It mirrors the subset of the `numpy.random.Generator` API:
+
+- `random`
+- `uniform`
+- `normal`
+- `choice`
+
+letting you pick the underlying backend at runtime. The following backends are
+currently supported:
+
+- `numpy`
+- `torch`
+- `cupy`
+- `jax`
+
+## Installation
+
+The core package only depends on the standard Python library:
+
+```bash
+pip install orng
+```
+
+Backends are optional extras that you can install on demand:
+
+```bash
+pip install "orng[numpy]"   # NumPy RNG support
+pip install "orng[torch]"   # PyTorch RNG support
+pip install "orng[cupy]"    # CuPy RNG support
+pip install "orng[jax]"     # JAX RNG support
+```
+
+You can also combine extras, e.g. `pip install "orng[numpy,torch]"`.
+
+## Quick Start
+
+```python
+from orng import ArrayRNG
+
+rng = ArrayRNG(backend="numpy", seed=42)
+samples = rng.normal(loc=0.0, scale=1.0, size=5)
+uniform = rng.uniform(low=-1.0, high=1.0, size=(2, 2))
+```
+
+The backend module is imported lazily. If the requested library is missing,
+`ArrayRNG` will raise an informative `ImportError` that points to the matching
+extra.
+
+### Backend State Reference
+
+When you pass the optional `generator` argument to `ArrayRNG`, the expected
+object depends on the backend:
+
+| Backend | Generator argument |
+|---------|--------------------|
+| `numpy` | `numpy.random.Generator` |
+| `torch` | `torch.Generator` |
+| `cupy`  | `cupy.random.Generator` |
+| `jax`   | `jax.random.KeyArray` (from `jax.random.key`) |
+
+This lets you wrap an existing RNG/key instead of seeding a new one.
+
+## Project Layout
+
+```
+orng/
+├── src/orng/
+│   ├── __init__.py      # package exports
+│   ├── _utils.py        # shared helpers (internal)
+│   ├── orng.py          # ArrayRNG facade
+│   └── backends/        # backend-specific implementations
+└── README.md
+```
+
+Each backend class lives in its own module under `orng/backends/`, keeping the
+core facade compact and making optional dependencies easy to manage.

orng-0.1.0a1/pyproject.toml

@@ -0,0 +1,66 @@
+[build-system]
+requires = ["setuptools>=68", "wheel", "setuptools-scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "orng"
+description = "Omni RNG: A unified, cross-backend random number generator built on the Array API standard."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { file = "LICENSE" }
+authors = [
+    { name = "Michael J. Williams" },
+    { name = "Christian Chapman-Bird" }
+]
+dependencies = []
+dynamic = [
+    "version"
+]
+
+[project.urls]
+Homepage = "https://github.com/sequince-dev/orng"
+Repository = "https://github.com/sequince-dev/orng"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["orng*"]
+
+[tool.setuptools_scm]
+
+[project.optional-dependencies]
+numpy = ["numpy>=1.22"]
+torch = ["torch>=2.0"]
+cupy = ["cupy>=12.0"]
+jax = ["jax>=0.4"]
+
+[dependency-groups]
+test = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+]
+dev = [
+    "pre-commit",
+    "mypy>=1.10",
+    {include-group = "test"},
+]
+
+[tool.ruff]
+line-length = 79
+indent-width = 4
+target-version = "py310"
+
+[tool.ruff.lint]
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+extend-select = ["I"]
+
+[tool.mypy]
+python_version = "3.10"
+packages = ["orng"]
+mypy_path = ["src"]
+ignore_missing_imports = true
+warn_unused_configs = true
+show_error_codes = true

orng-0.1.0a1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

orng-0.1.0a1/src/orng/__init__.py

@@ -0,0 +1,10 @@
+import importlib.metadata
+
+try:
+    __version__ = importlib.metadata.version("orng")
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "unknown"
+
+from .orng import ArrayRNG
+
+__all__ = ["ArrayRNG", "__version__"]

orng-0.1.0a1/src/orng/_utils.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+import math
+from typing import Sequence, Tuple
+
+SizeLike = int | Sequence[int] | None
+
+
+def normalize_shape(size: SizeLike) -> Tuple[int, ...]:
+    """Convert a size argument to a canonical ``tuple`` form."""
+    if size is None:
+        return ()
+    if isinstance(size, int):
+        if size < 0:
+            raise ValueError("size must be non-negative.")
+        return (size,)
+    shape = tuple(int(dim) for dim in size)
+    if any(dim < 0 for dim in shape):
+        raise ValueError("size entries must be non-negative.")
+    return shape
+
+
+def total_size(shape: Tuple[int, ...]) -> int:
+    if not shape:
+        return 1
+    return math.prod(shape)
+
+
+__all__ = ["SizeLike", "normalize_shape", "total_size"]