semvec/pypi-packages huggingface dataset:
craps-dice-combos-names 0.1.127.2
A miniscule library for generating and identifying dice combos in craps
License: BSD 2-clause

# Craps Nicknames

Craps Nicknames is a tiny Python package that returns a randomized dice roll with it's associated craps nickname. The nicknames are based on the following chart by [Vital Vegas](https://vitalvegas.com/colorful-nicknames-dice-combinations-craps/):

![Craps Nicknames Charts](https://vitalvegas.com/wp-content/uploads/2015/02/craps_dice_rolls_updated.jpg)

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install craps-pkg.

```python
pip install craps-dice-combos-names
```

## Usage

```python
import craps_pkg

craps_pkg.craps_roll()
# returns {
# "dice_pair": [1,2],
# "nickname": "Australian yo"
# }

craps_pkg.get_combo_name([2,2]) # returns "Ballerina"

craps_pkg.get_dice_combos()
# returns {
#   'Snake Eyes': [1, 1],
#   'Australian yo': [1, 2],
#   ...
#   'Six five no jive': [6, 5],
#   'Midnight': [6, 6]
# }
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](https://choosealicense.com/licenses/mit/)