Kaomoji

Create procedurally generated kaomoji (i.e., Japanese emoticons) using Python! \(^ヮ^)/

This Python package uses procedural generation to create kaomoji using a collection of features (e.g., eyes, arms, etc.) across a wide variety of different categories, such as emotions (e.g., joy, indifference, love) and animals (e.g., dog, cat, etc.). Also, the individual kaomoji features and template used to organize the features are fully customizable.

Installation

Installation is easy using the pip package manager.

$ pip install --user kaomoji

Example

Run the following command on the console to view a pre-fab example.

$ python -m kaomoji

Usage

The first step is to import the Kaomoji class.

> from kaomoji.kaomoji import Kaomoji

Next, instantiate a Kaomoji object.

> kao = Kaomoji()

Using the Kaomoji object, procedurally generate a kaomoji from a random category.

> kao.create()

Or, generate a kaomoji from a specific category.

> kao.create("joy")

All of the available categories are easily viewable on the categories attribute.

> kao.categories

Releases

This project adheres to Semantic Versioning. See CHANGELOG for a detailed release history.

Contributing

Contributions are welcome. See CONTRIBUTING for instructions on how to contribute to this project.

License

Distributed under the MIT license. See LICENSE for more information.

Author

This project was made with 💖 by Keith Dowd @ keith.dowd@gmail.com.

Acknowledgements

Big thanks to Japan for creating kaomoji and anime.

Also, huge shoutout to kaomoji.ru for the history and wonderfully expansive and organized collection of kaomoji.