mitchallen-roll 1.0.12

A dice rolling random number generator

mitchallen-roll

A simple dice rolling random number generator for Python.

Installation

pip install mitchallen-roll

Or with uv:

uv add mitchallen-roll

Usage

from mitchallen.roll import roll, d6, d20

# Roll a standard 6-sided die
result = roll()  # Returns 1-6

# Roll a custom die
result = roll(20)  # Returns 1-20

# Convenience functions
result = d6()   # Roll a 6-sided die
result = d20()  # Roll a 20-sided die

API Reference

roll(sides=6) -> int

Roll a die with the specified number of sides.

Parameters:

• sides (int): Number of sides on the die (default: 6, minimum: 1)

Returns:

• int: A random integer from 1 to sides (inclusive)

Raises:

• ValueError: If sides is less than 1

d6() -> int

Convenience function to roll a 6-sided die.

Returns:

• int: A random integer from 1 to 6

d20() -> int

Convenience function to roll a 20-sided die.

Returns:

• int: A random integer from 1 to 20

Development

See the main repository README for development setup instructions.

License

MIT License - see LICENSE file for details