vibeutils 0.4.0

A Python library that provides various utils using OpenAI API

vibeutils

A Python utils library that counts letter frequency, compares numbers, and evaluates mathematical expressions using OpenAI API.

Features

• Count frequency of specific letters in text
• Compare two numbers using AI
• Evaluate mathematical expressions safely
• Case-sensitive and case-insensitive counting options
• Uses OpenAI API for prompt injection detection

Upcoming

• vibelength()
• viebtime
• ...

Performance

• Time complexity: O(luck) and I use API calls to prevent prompt injection.

Installation

Install the package using pip:

pip install vibeutils

Setup

You need to provide your own OpenAI API key. Set it as an environment variable:

export OPENAI_API_KEY=your_openai_api_key_here

Usage

Letter Counting - vibecount()

from vibeutils import vibecount

# Count letter 'r' in "strawberry" (case-sensitive by default)
result = vibecount("strawberry", "r")
print(result)  # 2 ;)

# Case-insensitive counting
result = vibecount("Strawberry", "R", case_sensitive=False)
print(result)  # 2 ;)

# Case-sensitive counting (explicit)
result = vibecount("Strawberry", "R", case_sensitive=True)
print(result)  # 0 (no uppercase 'R' in "Strawberry")

Number Comparison - vibecompare()

from vibeutils import vibecompare

# Compare two integers
result = vibecompare(5, 10)
print(result)  # -1 (first number is smaller)

# Compare two floats
result = vibecompare(5.11, 5.9)
print(result)  # -1 ;)

# Compare equal numbers
result = vibecompare(7, 7)
print(result)  # 0 (numbers are equal)

Mathematical Expression Evaluation - vibeeval()

from vibeutils import vibeeval

# Basic arithmetic operations
result = vibeeval("2 + 3")
print(result)  # 5.0

result = vibeeval("3 * 4")
print(result)  # 12.0

# Complex expressions with parentheses
result = vibeeval("(2 + 3) * 4")
print(result)  # 20.0

# Decimal results
result = vibeeval("5 / 2")
print(result)  # 2.5

# Error handling for invalid expressions
try:
    result = vibeeval("2 +")  # Invalid syntax
except ValueError as e:
    print(f"Error: {e}")

try:
    result = vibeeval("2 ** 3")  # Unsupported operator
except ValueError as e:
    print(f"Error: {e}")

try:
    result = vibeeval("1 / 0")  # Division by zero
except ValueError as e:
    print(f"Error: {e}")

Parameters

vibecount(text, target_letter, case_sensitive=True)

• text (str): The input string to analyze
• target_letter (str): The letter to count (must be a single character)
• case_sensitive (bool, optional): Whether to perform case-sensitive counting (default: True)

vibecompare(num1, num2)

• num1 (Union[int, float]): The first number to compare
• num2 (Union[int, float]): The second number to compare

vibeeval(expression)

• expression (str): Mathematical expression containing numbers, operators (+, -, *, /), and parentheses

Return Values

• vibecount(): Returns an integer representing the count of the target letter
• vibecompare(): Returns an integer:
  • -1 if the first number is smaller than the second
  • 0 if the numbers are equal
  • 1 if the first number is larger than the second
• vibeeval(): Returns a float representing the result of the mathematical expression

Error Handling

All functions raise:

• ValueError: If OpenAI API key is not set, invalid arguments provided, or invalid mathematical expression (vibeeval only)
• Exception: If OpenAI API call fails or response validation fails

Requirements

• Python 3.8+
• OpenAI API key
• Internet connection for API calls

Dependencies

• openai>=1.0.0

Development

Running Tests

Install test dependencies:

pip install -r test-requirements.txt

Run tests:

pytest

Run tests with coverage:

pytest --cov=vibeutils

Run specific test file:

pytest tests/test_vibeutils.py

Test Structure

The test suite includes:

• Unit tests for all function parameters and edge cases
• Mock tests for OpenAI API calls (no actual API calls during testing)
• Error handling validation
• Input validation tests

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Note

This package uses the OpenAI API for processing, which requires an API key and internet connection. Each function call will make more than 1 request to OpenAI's servers and will consume API credits.