Skip to content

Latest commit

 

History

History
67 lines (40 loc) · 2.59 KB

README.md

File metadata and controls

67 lines (40 loc) · 2.59 KB

Brawndo

build

It's Got Electrolytes!

Makes your terminal text chaotic. It's got what plants crave!

See on PyPI

Install

pip install brawndo

Modifying

First, set up the environment:
cd .../3-python-package-exercise-team-not-sure

Enter the pipenv:
pipenv shell

Build (in project root): python -m build

Modify pyproject.toml to whatever you want.

You can then use twine upload dist/* to upload to PyPI.

Functions

Import with from brawndo.brawndo import *.

rainbow_deterministic(text: str, shift: int, testing=False) -> Optional[str]

  • Prints out colors for each character in your text, making the same characters the same color.
  • When run with the same shift, it stays the same each time! Change it to preference.
  • Specify testing=True to get an additional output string (for testing).

word_deterministic(text: str, shift: int, testing=False) -> Optional[str]

  • Prints out colors for each word in your text, making the same words the same color.
  • When run with the same shift, it stays the same each time! Change it to preference.
  • Specify testing=True to get an additional output string (for testing).

rainbow_random(text: str, rndseed=None, testing=False) -> Optional[str]

  • By default, randomizes colors for each character.
  • You can get a reproducible color order if you specify the same random seed!
  • Specify testing=True to get an additional output string (for testing).

def word_random(text: str, operate_on_sentences: bool, rndseed=None, testing=False) -> None

  • By default, randomizes color for each word (or entire sentence, if you specify operate_on_sentences=True).
  • You can get a reproducible color order if you specify the same random seed!
  • Specify testing=True to get an additional output string (for testing).

Team Members

Michael Lin <[email protected]>

Seolin Jung <[email protected]>

Marwan AbdElhameed <[email protected]>

Pavly Halim <[email protected]>