pythodds 0.1.8__py3-none-any.whl

pythodds-0.1.8.dist-info/METADATA

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: pythodds
+Version: 0.1.8
+Summary: Command line utilities for statistics, odds, and probabilities
+Author-email: Nicholas Carsner <nicholascarsner@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: binomial,cli,odds,probability,statistics
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# pythodds
+
+[![PyPI version](https://badge.fury.io/py/pythodds.svg)](https://pypi.org/project/pythodds/)
+[![Python 3.13+](https://img.shields.io/badge/python-3.13+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/yourusername/pythodds/blob/main/LICENSE)
+
+A command-line utility and Python library for calculating statistics, odds, and probabilities.
+
+## Features
+
+- **Binomial Distribution**: Calculate PMF, CDF, and survival functions for binomial distributions
+- **Command-line Interface**: Easy-to-use CLI tool (`binom` command)
+- **Pure Python**: No external dependencies
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install pythodds
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/yourusername/pythodds.git
+cd pythodds
+pip install -e .
+```
+
+## Usage
+
+### Command Line
+
+```bash
+# Calculate binomial distribution probabilities
+binom -n 10 -k 3 -p 0.4
+
+# Specify a target and minimum probability threshold
+binom -n 100 -k 30 -p 0.35 --target 40 --min-prob 0.05
+```
+
+### Python Library
+
+```python
+from utils.binomial_distribution import binomial_pmf, binomial_cdf_le, binomial_cdf_ge
+
+# P(X = 3) for Binomial(n=10, p=0.4)
+pmf = binomial_pmf(10, 3, 0.4)
+
+# P(X <= 3) for Binomial(n=10, p=0.4)
+cdf = binomial_cdf_le(10, 3, 0.4)
+
+# P(X >= 3) for Binomial(n=10, p=0.4)
+survival = binomial_cdf_ge(10, 3, 0.4)
+```
+
+## Development
+
+Clone the repository and install in editable mode:
+
+```bash
+git clone https://github.com/yourusername/pythodds.git
+cd pythodds
+pip install -e .
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Author
+
+Your Name - [@yourusername](https://github.com/yourusername)

pythodds-0.1.8.dist-info/RECORD

@@ -0,0 +1,8 @@
+src/__init__.py,sha256=EEiYwuxYvjris9ZRmHY23fVHPwUyGc0Rlou65MObEoo,104
+src/utils/__init__.py,sha256=O-MGpi86D2C_rw6pPi6OTbRW_CJURT4NReVfrnGQcuw,217
+src/utils/binomial_distribution.py,sha256=V7_zl8P5hry3aP461sTjvmlW6ijaMbBQXIhOCFa4OVQ,3624
+pythodds-0.1.8.dist-info/METADATA,sha256=56G_-v4HjEAt7o9aAf0QzwuooiO41bB6e-pRixWVCG4,2521
+pythodds-0.1.8.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+pythodds-0.1.8.dist-info/entry_points.txt,sha256=YarbxXlq-YQh1g4_CCpFCsOe68BxpKnPIKlksVXuWQs,59
+pythodds-0.1.8.dist-info/licenses/LICENSE,sha256=S9Ffuox47AoTxiwJ0U_qpHi_cE9PCxWAyS2mYi0wbHw,1073
+pythodds-0.1.8.dist-info/RECORD,,

pythodds-0.1.8.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pythodds-0.1.8.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+binom = utils.binomial_distribution:main

pythodds-0.1.8.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nicholas Carsner
+
+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.

src/__init__.py

@@ -0,0 +1,3 @@
+"""Pythodds - Command line utilities for statistics, odds, and probabilities."""
+
+__version__ = "0.1.8"

src/utils/__init__.py

@@ -0,0 +1,13 @@
+"""Utility modules for pythodds."""
+
+from .binomial_distribution import (
+    binomial_pmf,
+    binomial_cdf_le,
+    binomial_cdf_ge,
+)
+
+__all__ = [
+    "binomial_pmf",
+    "binomial_cdf_le",
+    "binomial_cdf_ge",
+]

src/utils/binomial_distribution.py

@@ -0,0 +1,105 @@
+#!/usr/bin/env python3
+from __future__ import annotations
+
+import argparse
+import math
+import sys
+from typing import Optional
+
+"""Command-line utility to compute binomial distribution probabilities.
+
+Usage examples:
+  python scripts/probability_binom.py -n 10 -k 3 -p 0.4
+  python scripts/probability_binom.py -n 100 -k 30 -p 0.35 --target 40 --min-prob 0.05
+
+Prints PMF for exactly `k`, CDF for `<= k`, survival `>= k`, and optionally
+the probability of meeting a `target` number of successes and whether that
+probability meets a provided minimum threshold (`--min-prob`).
+"""
+
+def binomial_pmf(n: int, k: int, p: float) -> float:
+    """Probability mass function P(X = k) for Binomial(n, p)."""
+    if k < 0 or k > n:
+        return 0.0
+    return math.comb(n, k) * (p ** k) * (1 - p) ** (n - k)
+
+
+def binomial_cdf_le(n: int, k: int, p: float) -> float:
+    """Cumulative distribution P(X <= k) for Binomial(n, p)."""
+    if k < 0:
+        return 0.0
+    if k >= n:
+        return 1.0
+    total = 0.0
+    for i in range(0, k + 1):
+        total += binomial_pmf(n, i, p)
+    return total
+
+
+def binomial_cdf_ge(n: int, k: int, p: float) -> float:
+    """Survival function P(X >= k) for Binomial(n, p)."""
+    if k <= 0:
+        return 1.0
+    if k > n:
+        return 0.0
+    return 1.0 - binomial_cdf_le(n, k - 1, p)
+
+
+def parse_args(argv: Optional[list[str]] = None) -> argparse.Namespace:
+    parser = argparse.ArgumentParser(description="Binomial distribution helper")
+    parser.add_argument("-n", "--trials", type=int, required=True, help="number of trials (n)")
+    parser.add_argument("-k", "--successes", type=int, required=True, help="number of successes (k) to evaluate")
+    parser.add_argument("-p", "--p", type=float, required=True, help="historical success probability (0..1)")
+    parser.add_argument("--target", type=int, default=None, help="optional target number of successes to evaluate P(X >= target)")
+    parser.add_argument("--min-prob", type=float, default=None, help="optional minimum acceptable probability for the target (0..1)")
+    parser.add_argument("--precision", type=int, default=6, help="decimal places for printed probabilities")
+    return parser.parse_args(argv)
+
+
+def format_prob(x: float, precision: int) -> str:
+    pct = x * 100.0
+    fmt = f"{{:.{precision}f}}"
+    return f"{fmt.format(x)} ({fmt.format(pct)}%)"
+
+
+def main(argv: Optional[list[str]] = None) -> int:
+    args = parse_args(argv)
+
+    n = args.trials
+    k = args.successes
+    p = args.p
+    precision = args.precision
+
+    if not (0.0 <= p <= 1.0):
+        print("Error: --p must be between 0 and 1", file=sys.stderr)
+        return 2
+    if n < 0:
+        print("Error: --trials must be non-negative", file=sys.stderr)
+        return 2
+
+    exact = binomial_pmf(n, k, p)
+    le = binomial_cdf_le(n, k, p)
+    ge = binomial_cdf_ge(n, k, p)
+
+    print(f"n={n}, k={k}, p={p}")
+    print(f"P(X = {k}): {format_prob(exact, precision)}")
+    print(f"P(X <= {k}): {format_prob(le, precision)}")
+    print(f"P(X >= {k}): {format_prob(ge, precision)}")
+
+    if args.target is not None:
+        target = args.target
+        pt = binomial_cdf_ge(n, target, p)
+        print(f"P(X >= {target}): {format_prob(pt, precision)}")
+        if args.min_prob is not None:
+            minp = args.min_prob
+            if not (0.0 <= minp <= 1.0):
+                print("Error: --min-prob must be between 0 and 1", file=sys.stderr)
+                return 2
+            meets = pt >= minp
+            print(f"Meets minimum {format_prob(minp, precision)}: {meets}")
+
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())