Skip to main content

A library to emulate rolling dice

Project description

Dragn

PyPI version Supported Python versions Build Status codecov License Downloads Code style: Black

Dice system library (aka random.randint as dice).

A library that makes something simple like a random integer even simpler.

Or at least, makes it look a bit more like rolling dice.

Why?

I wanted a better API to rolling dice using Python, and the usual random.randint is very good, but doesn't really represent rolling dice quite the way I imagine it.

This was a good learning experiment, but I'm not expecting anyone to use it.

Who is this for?

People building RPGs, or games that would involve dice and who care about how their code looks like.

I may be biased, but I really believe that this library provides a much better interface than pure random.randint.

How to install

$ pip install dragn

How to use

>> from dragn.dice import D4, D6, D8
>>> D6()
1
>>> f"You roll the die and the result is {D8()}"
'You roll the die and the result is 4'
>>> f"You roll 3 dice and you get {[D8() for _ in range(3)]}"
>>> 'You roll 3 dice and you get [3, 1, 8]'
>>> four_dice = D4 * 4
>>> f"You roll 4 dice and the results are {four_dice()}"
'You roll 4 dice and the results are (4, 3, 1, 2)'
>>> f"You roll two dice and the results are {two_dice()}"
'You roll two dice and the results are (3, 4)'

For more examples, check the tests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dragn-0.2.0.tar.gz (4.2 kB view hashes)

Uploaded Source

Built Distribution

dragn-0.2.0-py3-none-any.whl (5.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page