spongemock 0.2.1

Mock some text like spongebob would. mOCk SoMe TexT lIKe SpONGebOb wOuLd.

spongemock
##########
.. line-block::
Me: Mock some text like spongebob would.
You: mOCk SoMe TexT lIKe SpONGebOb wOuLd.

.. image:: http://pixel.nymag.com/imgs/daily/vulture/2017/05/16/16-spongebob-explainer.w710.h473.2x.jpg
:alt: spongemock


How to Install
==============
``pip install spongemock``

or (for python3 specifically)

``pip3 install spongemock``

If you are having troube with the ``-c`` copy option (especially on Linux), please refer to |pyperclipinstallation|_.

.. _pyperclipinstallation: https://github.com/asweigart/pyperclip

.. |pyperclipinstallation| replace:: *pyperclip*'s installation instructions



How To Use
==========
``spongemock [-h] [-c] [-b BIAS] [-s SEED | -S STRSEED] text [text ...]``

positional arguments
--------------------
``text`` - the text to mock. ThE tExT tO mOCk.

optional arguments
------------------
``-h``, ``--help`` - show this help message and exit

``-c``, ``--copy`` - copy the mocked text to the clipboard.

``-b BIAS``, ``--bias BIAS`` - this bias is used to succesively increase the chance of swapping from the previously-mocked case. A value of ``0`` will ensure the chance is always 50/50, and a value of ``1`` will ensure that after the first random choice the capitalization perfectly oscilates. Default is ``0.5``.

``-s SEED``, ``--seed SEED`` - seed for random number generator. Can be any number or string (numbers are parsed).

``-S STRSEED``, ``--strseed STRSEED`` - seed for random number generator. Does not attempt to parse the string to a number.

Patch Notes
===========
v0.2.1
------
- Fixed program-breaking error
v0.2
----
- Fixed up error messaging when using the ``-c`` copy option
- Added a "How to Install" section to the README
- Fixed some README issues w/ spelling and semantics