Skip to content

Latest commit

 

History

History
84 lines (65 loc) · 3.25 KB

README.md

File metadata and controls

84 lines (65 loc) · 3.25 KB

Democritus Random

PyPI CI Lint codecov The Democritus Project uses semver version 2.0.0 The Democritus Project uses black to format code License: LGPL v3

Democritus functions[1] for working with random.

[1] Democritus functions are simple, effective, modular, well-tested, and well-documented Python functions.

We use d8s (pronounced "dee-eights") as an abbreviation for democritus (you can read more about this here).

Installation

pip install d8s-random

Usage

You import the library like:

from d8s_random import *

Once imported, you can use any of the functions listed below.

Functions

  • def random_number():
        """Return a random number in range [0.0, 1.0)."""
  • def random_integer(a=0, b=10):
        """Return a random number between a and b (inclusive)."""
  • def random_xkcd_integer():
        """Get a random number using the method described here: https://xkcd.com/221/."""
  • def random_dilbert_integer():
        """Get a random number using the method described here: https://dilbert.com/strip/2001-10-25c."""
  • def random_shuffle(iterable):
        """Shuffle the order of the given iterable."""
  • def random_choice(iterable):
        """Return a random item from the iterable."""
  • def random_choices(iterable, n: int):
        """Return a random item from the iterable."""
  • def random_sample(iterable, n):
        """Return n items, selected at random, from the iterable."""

Development

👋  If you want to get involved in this project, we have some short, helpful guides below:

If you have any questions or there is anything we did not cover, please raise an issue and we'll be happy to help.

Credits

This package was created with Cookiecutter and Floyd Hightower's Python project template.