facedbook 0.1.2

A package that incorporates kaomojis for the user.

facedbook

Project Description

facedBook is a fun Python package for transforming text with cute and eerie keyboard faces, generating scary stories, and displaying emotions with expressive faces.

Its features include:

• Replacing words in a sentence with expressive keyboard faces
• Generating creepy horror stories with random actions and spooky characters
• Displaying emotions with keyboard keys based on how a user is feeling
• Encoding words into emotion-based faces

Installation

You can install facedbook directly from PyPI using:

pip install facedbook

facedbook on PyPI

Usage and Examples

Once installed, you can easily use its functions in your Python code.

Replace words with faces: replace_with_faces()

from facedbook.faces import replace_with_faces

sentence = "This project is so cool and fun to use!"
print(replace_with_faces(sentence))

Example output:

This (づ ᴗ _ᴗ)づ♡ project (๑♡⌓♡๑) is fun ( ´͈ ᗨ `͈ )!

Generate a spooky story: face_story()

from facedbook.stories import face_story

print(face_story(3))  # Generates a 3-sentence scary story

Example output:

(ノωヽ) saw something move in the shadows behind (／。＼).
Σ(°△°|||)︴ was trapped in a haunted house with (つ﹏⊂).
(☉_☉’) was cursed by (ᗒᗣᗕ)՞.

Get a face based on emotion: ask_user_feeling()

from facedbook.feelings import ask_user_feeling

print(ask_user_feeling("happy"))  # Returns a happy face

Example output:

(⌒▽⌒)☆

Encode words into faces: face_encoder()

from facedbook.encoder import face_encoder

print(face_encoder("happy", 3))  # Returns 3 happy faces

Example output:

(* ^ ω ^)
╰(▔ ∀ ▔)╯
(✯◡✯)

Developer Setup & Contribution

1. Clone the Repository

git clone https://github.com/software-students-spring2025/3-python-package-everything.git
cd 3-python-package-everything

2. Create a Virtual Environment

pipenv install
pipenv shell

3. Install Dependencies

pipenv install --dev

4. Run Tests

pytest

5. Build and Publish the Package

python -m build
python -m twine upload dist/*

Contributors

• Claire Kim
• Jennifer Yu
• Iva Park
• Chrisim Kim

Configuration & Running Instructions

This package is compatible with Python 3.6+ and works on Windows, macOS, and Linux. Simply install with pip install facedbook and use the functions as demonstrated above!

For additional environment configurations, create a .env file:

# Example .env
DEBUG=True
LOG_LEVEL=INFO

Then load environment variables using:

from dotenv import load_dotenv
load_dotenv()