Metadata-Version: 2.1
Name: text-to-owo
Version: 2.0.0
Summary: Translates normal text into OwO speak. Port from Zuzak's javascript version
Home-page: https://github.com/piethrower/OwO
Author: Pie Thrower
Author-email: piethrowerchamp@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Classifier: Topic :: Text Processing :: Filters
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE

# OwO

Yet another owoifier. This specific one is a port of @zuzak's JavaScript [OWO](https://github.com/zuzak/owo) into Python, because we needed this to be in even more languages.

# Install

1.  Run the command `pip install text-to-owo` to install the package on your system.
2.  Add `import owo` to the beginning of your script.

# Usage

## Constants

<code>owo.**PREFIXES**</code>

Tuple containing default prefixes

<br/>

<code>owo.**SUFFIXES**</code>

Tuple containing default suffixes

<br/>

<code>owo.**SUBSTITUTIONS**</code>

Dict containing default substitutions


## Functions

<code>owo.**add_prefix**(*input*, *prefixes=owo.PREFIXES*)</code>

Appends a random prefix to the beginning and end of the string.
Custom prefixes are optional and must be passed as either a list or tuple of strings.

<br/>

<code>owo.**add_suffix**(*input*, *suffixes=owo.SUFFIXES*)</code>

Appends a random suffix to the beginning and end of the string.
Custom suffixes are optional and must be passed as either a list or tuple of strings.

<br/>

<code>owo.**add_affixes**(*input*, *prefixes=owo.PREFIXES*, *suffixes=owo.SUFFIXES*)</code>

Appends a random prefix and suffix to the beginning and end of the string.
Custom prefixes and suffixes are optional and must be passed as either a list or tuple of strings.

<br/>

<code>owo.**substitute**(*input*, *substitutions=owo.SUBSTITUTIONS*)</code>

Turns the text into owo speak without adding any prefixes or suffixes.
Custom substitutions are optional and must be passed as dictionary in the form `{"key":"replacement"}`.

<br/>

<code>owo.**owo**(*input*, *prefixes=owo.PREFIXES*, *suffixes=owo.SUFFIXES*, *substitutions=owo.SUBSTITUTIONS*)</code>

Both substitutes and adds prefixes and suffixes.
Optional prefixes, suffixes, and substitutions are the same as in other methods.

<br/>

For all optional arguments the given iterable/dict will replace the default values, not add to them.

All functions take a single string as input and output a string.


# Example

```python
import owo

print(owo.owo("I have no mouth and I must scream"))
# HIIII! I haz nu mouth and I must scweam XDDD

print(owo.substitute("I have no mouth and I must scream"))
# I haz nu mouth and I must scweam
```


