randcraft 0.1.4__tar.gz

randcraft-0.1.4/.github/workflows/publish.yml

@@ -0,0 +1,76 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          # Install a specific version of uv.
+           version: "0.8.16"
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Build release distributions
+        run: |
+          uv build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      url: https://pypi.org/project/randcraft
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

randcraft-0.1.4/.github/workflows/tests.yml

@@ -0,0 +1,41 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python application
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.12"
+    
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        # Install a specific version of uv.
+        version: "0.8.16"
+
+    - name: Install the project
+      run: uv sync --locked --all-extras --dev
+
+    - name: Lint with ruff
+      run: |
+        uv run ruff check randcraft --output-format=full
+    
+    - name: Test with pytest
+      run: uv run pytest tests

randcraft-0.1.4/.gitignore

@@ -0,0 +1,179 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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
+.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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# IDE
+.idea/
+src/game_cache/*.json
+src/game_cache/*.html

randcraft-0.1.4/.python-version

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

randcraft-0.1.4/.vscode/settings.json

@@ -0,0 +1,34 @@
+{
+    "python.testing.unittestArgs": [
+        "-v",
+        "-s",
+        "./tests",
+        "-p",
+        "test*.py"
+    ],
+    "python.testing.pytestEnabled": false,
+    "python.testing.unittestEnabled": true,
+    "python.terminal.activateEnvironment": true,
+    "python.analysis.typeCheckingMode": "basic",
+    "python.analysis.diagnosticMode": "workspace",
+    "[python]": {
+        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.codeActionsOnSave": {
+            "source.organizeImports": "always",
+            "source.sortImports": "always",
+            "source.unusedImports": "always"
+        }
+    },
+    "autoDocstring.generateDocstringOnEnter": true,
+    "autoDocstring.docstringFormat": "google",
+    "terminal.integrated.env.windows": {
+        "PYTHONPATH": "${workspaceFolder}"
+    },
+    "workbench.tree.indent": 20,
+    "editor.semanticTokenColorCustomizations": {
+        "rules": {
+            "selfParameter": "#e181ff",
+            "clsParameter": "#e181ff",
+        }
+    }
+}

randcraft-0.1.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Robbie Muir
+
+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.

randcraft-0.1.4/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.4
+Name: randcraft
+Version: 0.1.4
+Summary: An object-oriented approach to defining and combining random variables
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: matplotlib>=3.10.6
+Requires-Dist: numpy>=2.3.3
+Requires-Dist: pandas>=2.3.0
+Requires-Dist: scipy>=1.16.1
+Description-Content-Type: text/markdown
+
+# RandCraft
+
+RandCraft is a Python library for object-oriented combination and manipulation of univariate random variables, built on top of the [scipy.stats](https://docs.scipy.org/doc/scipy/reference/stats.html) module.
+
+
+## Usage Example
+Have you ever wanted to add together random variables but can't be bothered working out an analytical solution?
+Randcraft makes it simple.
+
+```python
+from randcraft import make_normal, make_coin_flip
+
+coin_flip = make_coin_flip()
+# <RandomVariable(discrete): mean=0.5, var=0.25>
+norm = make_normal(mean=0, std_dev=0.2)
+# <RandomVariable(normal): mean=0.0, var=0.04>
+combined = coin_flip + norm 
+# <RandomVariable(mixture): mean=0.5, var=0.29>
+combined.sample_one()
+# 0.8678903828104276
+combined.plot()
+```
+![Double normal](images/double_normal.png)
+
+
+## Features
+
+- **Object-oriented random variables:** Wrap and combine distributions as Python objects.
+- **Distribution composition:** Add, multiply, and transform random variables.
+- **Sampling and statistics:** Easily sample from composed distributions and compute statistics.
+- **Extensible:** Supports custom distributions via subclassing.
+- **Integration with scipy.stats:** Use any frozen continuous distribution from scipy stats
+
+## Supported Distributions
+
+RandCraft currently supports the following distributions:
+
+- Normal, Uniform, Beta, Gamma + any other parametric continuous distribution from scipy.stats
+- Discrete
+- DiracDelta
+- Gaussian kde distribution from provided observations
+- Mixture distributions
+- Anonymous distribution functions based on a provided sampler function
+
+Distributions can all be combined arbitrarily with addition and subtraction.
+The library will simplify the new distribution analytically where possible, and use numerical approaches otherwise.
+
+You can also extend RandCraft with your own custom distributions.
+
+## Installation
+
+```bash
+pip install randcraft
+```
+
+## API Overview
+
+- `make_normal`, `make_uniform` ...etc: Create a random variable
+- Addition subtraction with constants or other RVs: `+`, `-`
+- `.sample_numpy(size)`: Draw samples
+- `.get_mean()`, `.get_variance()`: Get statistics
+- `.cdf(x)`: Evaluate cdf at points
+- `.ppf(x)`: Evaluate inverse of cdf at points
+- `.plot()`: Take a look at your distribution
+
+## More Examples
+### Combining dice rolls
+```python
+from randcraft.constructors import make_die_roll
+
+die = make_die_roll(sides=6)
+# <RandomVariable(discrete): mean=3.5, var=2.92>
+three_dice = die.multi_sample(3)
+# <RandomVariable(discrete): mean=10.5, var=8.75>
+three_dice.cdf(10.0)
+# 0.5
+three_dice.ppf(0.5)
+# 10.0
+```
+
+### Using arbitrary parametric continuous distribution from scipy.stats
+```python
+from scipy.stats import uniform
+from randcraft.constructors import make_scipy
+
+rv = make_scipy(uniform, loc=1, scale=2)
+# <RandomVariable(scipy-uniform): mean=2.0, var=0.333>
+b = rv.scale(2.0)
+# <RandomVariable(scipy-uniform): mean=4.0, var=1.33>
+```
+
+### Kernel density estimation and combination
+You have observations of two independent random variables. You want to use kernal density estimation to create continuous random variables for each and then add them together.
+```python
+import numpy as np
+from randcraft.observations import make_gaussian_kde
+
+observations_a = np.array([1.0, 2.0, 3.0, 4.0, 5.0])
+observations_b = np.array([1.0, 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0])
+rv_a = make_gaussian_kde(observations=observations_a, bw_method=0.1)
+# <RandomVariable(multi): mean=3.0, var=2.42>
+rv_b = make_gaussian_kde(observations=observations_b)
+# <RandomVariable(multi): mean=0.5, var=0.676>
+rv_joined = rv_a + rv_b
+# <RandomVariable(multi): mean=3.5, var=3.1>
+```
+Uses `gaussian_kde` by `scipy.stats` under the hood. You also have the option to pass arguments for `gaussian_kde`, or provide your own kernel as a `RandomVariable`.
+
+### Mixing continuous and discrete variables
+You have observations of two independent random variables. You want to use kernal density estimation to create continuous random variables for each and then add them together.
+```python
+from randcraft.constructors import make_normal, make_uniform, make_discrete
+from randcraft.misc import mix_rvs
+
+rv1 = make_normal(mean=0, std_dev=1)
+# <RandomVariable(scipy-norm): mean=0.0, var=1.0>
+rv2 = make_uniform(low=-1, high=1)
+# <RandomVariable(scipy-uniform): mean=-0.0, var=0.333>
+combined = rv1 + rv2
+# <RandomVariable(multi): mean=0.0, var=1.33>
+discrete = make_discrete(values=[1, 2, 3])
+# <RandomVariable(discrete): mean=2.0, var=0.667>
+
+# Make a new rv which has a random chance of drawing from one of the other 4 rvs
+mixture = mix_rvs([rv1, rv2, combined, discrete])
+# <RandomVariable(mixture): mean=0.5, var=1.58>
+mixture.plot()
+```
+![Mixture](images/mixture.png)
+
+
+
+## Extending RandCraft
+
+You can create custom random variable classes by subclassing the base RV class and implementing required methods.
+
+## Known limitations
+
+The library is designed to work with univariate random variables only. Multi-dimensional rvs or correlations etc are not supported.
+
+## License
+
+MIT License
+
+## Acknowledgements
+
+Built on [scipy.stats](https://docs.scipy.org/doc/scipy/reference/stats.html).

randcraft-0.1.4/README.md

@@ -0,0 +1,147 @@
+# RandCraft
+
+RandCraft is a Python library for object-oriented combination and manipulation of univariate random variables, built on top of the [scipy.stats](https://docs.scipy.org/doc/scipy/reference/stats.html) module.
+
+
+## Usage Example
+Have you ever wanted to add together random variables but can't be bothered working out an analytical solution?
+Randcraft makes it simple.
+
+```python
+from randcraft import make_normal, make_coin_flip
+
+coin_flip = make_coin_flip()
+# <RandomVariable(discrete): mean=0.5, var=0.25>
+norm = make_normal(mean=0, std_dev=0.2)
+# <RandomVariable(normal): mean=0.0, var=0.04>
+combined = coin_flip + norm 
+# <RandomVariable(mixture): mean=0.5, var=0.29>
+combined.sample_one()
+# 0.8678903828104276
+combined.plot()
+```
+![Double normal](images/double_normal.png)
+
+
+## Features
+
+- **Object-oriented random variables:** Wrap and combine distributions as Python objects.
+- **Distribution composition:** Add, multiply, and transform random variables.
+- **Sampling and statistics:** Easily sample from composed distributions and compute statistics.
+- **Extensible:** Supports custom distributions via subclassing.
+- **Integration with scipy.stats:** Use any frozen continuous distribution from scipy stats
+
+## Supported Distributions
+
+RandCraft currently supports the following distributions:
+
+- Normal, Uniform, Beta, Gamma + any other parametric continuous distribution from scipy.stats
+- Discrete
+- DiracDelta
+- Gaussian kde distribution from provided observations
+- Mixture distributions
+- Anonymous distribution functions based on a provided sampler function
+
+Distributions can all be combined arbitrarily with addition and subtraction.
+The library will simplify the new distribution analytically where possible, and use numerical approaches otherwise.
+
+You can also extend RandCraft with your own custom distributions.
+
+## Installation
+
+```bash
+pip install randcraft
+```
+
+## API Overview
+
+- `make_normal`, `make_uniform` ...etc: Create a random variable
+- Addition subtraction with constants or other RVs: `+`, `-`
+- `.sample_numpy(size)`: Draw samples
+- `.get_mean()`, `.get_variance()`: Get statistics
+- `.cdf(x)`: Evaluate cdf at points
+- `.ppf(x)`: Evaluate inverse of cdf at points
+- `.plot()`: Take a look at your distribution
+
+## More Examples
+### Combining dice rolls
+```python
+from randcraft.constructors import make_die_roll
+
+die = make_die_roll(sides=6)
+# <RandomVariable(discrete): mean=3.5, var=2.92>
+three_dice = die.multi_sample(3)
+# <RandomVariable(discrete): mean=10.5, var=8.75>
+three_dice.cdf(10.0)
+# 0.5
+three_dice.ppf(0.5)
+# 10.0
+```
+
+### Using arbitrary parametric continuous distribution from scipy.stats
+```python
+from scipy.stats import uniform
+from randcraft.constructors import make_scipy
+
+rv = make_scipy(uniform, loc=1, scale=2)
+# <RandomVariable(scipy-uniform): mean=2.0, var=0.333>
+b = rv.scale(2.0)
+# <RandomVariable(scipy-uniform): mean=4.0, var=1.33>
+```
+
+### Kernel density estimation and combination
+You have observations of two independent random variables. You want to use kernal density estimation to create continuous random variables for each and then add them together.
+```python
+import numpy as np
+from randcraft.observations import make_gaussian_kde
+
+observations_a = np.array([1.0, 2.0, 3.0, 4.0, 5.0])
+observations_b = np.array([1.0, 1.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0])
+rv_a = make_gaussian_kde(observations=observations_a, bw_method=0.1)
+# <RandomVariable(multi): mean=3.0, var=2.42>
+rv_b = make_gaussian_kde(observations=observations_b)
+# <RandomVariable(multi): mean=0.5, var=0.676>
+rv_joined = rv_a + rv_b
+# <RandomVariable(multi): mean=3.5, var=3.1>
+```
+Uses `gaussian_kde` by `scipy.stats` under the hood. You also have the option to pass arguments for `gaussian_kde`, or provide your own kernel as a `RandomVariable`.
+
+### Mixing continuous and discrete variables
+You have observations of two independent random variables. You want to use kernal density estimation to create continuous random variables for each and then add them together.
+```python
+from randcraft.constructors import make_normal, make_uniform, make_discrete
+from randcraft.misc import mix_rvs
+
+rv1 = make_normal(mean=0, std_dev=1)
+# <RandomVariable(scipy-norm): mean=0.0, var=1.0>
+rv2 = make_uniform(low=-1, high=1)
+# <RandomVariable(scipy-uniform): mean=-0.0, var=0.333>
+combined = rv1 + rv2
+# <RandomVariable(multi): mean=0.0, var=1.33>
+discrete = make_discrete(values=[1, 2, 3])
+# <RandomVariable(discrete): mean=2.0, var=0.667>
+
+# Make a new rv which has a random chance of drawing from one of the other 4 rvs
+mixture = mix_rvs([rv1, rv2, combined, discrete])
+# <RandomVariable(mixture): mean=0.5, var=1.58>
+mixture.plot()
+```
+![Mixture](images/mixture.png)
+
+
+
+## Extending RandCraft
+
+You can create custom random variable classes by subclassing the base RV class and implementing required methods.
+
+## Known limitations
+
+The library is designed to work with univariate random variables only. Multi-dimensional rvs or correlations etc are not supported.
+
+## License
+
+MIT License
+
+## Acknowledgements
+
+Built on [scipy.stats](https://docs.scipy.org/doc/scipy/reference/stats.html).

randcraft-0.1.4/main.py

@@ -0,0 +1,6 @@
+def main():
+    print("Hello from randcraft!")
+
+
+if __name__ == "__main__":
+    main()