ygglib 0.1.0

High-performance cache client with automatic authentication and multi-tenancy

YGG Python Client

High-performance cache client with automatic authentication and multi-tenancy support for Python.

Visit ygg.kluglabs.net for more information about the YGG platform.

Installation

pip install ygg

Quick Start

import os
import ygg

# Initialize with your API key
ygg.init(os.environ.get("YGG_API_KEY"))

# Basic operations
ygg.set("greeting", "Hello, World!")
ygg.set("user:123:name", "John Doe")
ygg.set("session:abc", "active", 3600)  # 1 hour expiration

# Retrieve values
greeting = ygg.get("greeting")
user_name = ygg.get("user:123:name")
session = ygg.get("session:abc")

print(f"Greeting: {greeting}")
print(f"User name: {user_name}")
print(f"Session: {session}")

# Check if keys exist
exists_greeting = ygg.exists("greeting")
print(f"Greeting exists: {exists_greeting}")

# Get TTL
ttl = ygg.ttl("session:abc")
print(f"Session TTL: {ttl} seconds")

# Cleanup
ygg.delete("greeting")
ygg.delete("user:123:name")
ygg.delete("session:abc")

# Close connection
ygg.close()

Advanced Operations

Custom Cache Commands

# Hash operations
ygg.cache("HMSET", "user:123:profile", "age", "30", "city", "New York")
profile = ygg.cache("HMGET", "user:123:profile", "age", "city")
print(f"User profile: {profile}")

# List operations
ygg.cache("LPUSH", "notifications:123", "Welcome message")
ygg.cache("LPUSH", "notifications:123", "System update")
notifications = ygg.cache("LRANGE", "notifications:123", 0, -1)
print(f"Notifications: {notifications}")

Pipeline Operations

# Batch operations for better performance
with ygg.pipeline() as pipe:
    pipe.set("batch:1", "value1")
    pipe.set("batch:2", "value2")
    pipe.set("batch:3", "value3")
    results = pipe.execute()

print(f"Pipeline results: {results}")

Configuration

Configure the client using environment variables:

• YGG_API_KEY: Your authentication API key (required)
• YGG_TIMEOUT: Request timeout in seconds (default: 30)
• YGG_MAX_RETRIES: Maximum retry attempts (default: 3)
• YGG_RETRY_DELAY: Delay between retries in seconds (default: 1.0)
• YGG_POOL_SIZE: Connection pool size (default: 10)

Note: The API base URL is always https://ygg-api.kluglabs.net and cannot be changed.

API Reference

Operation	Method	Description
set	ygg.set(key, value, ex?)	Set key-value pair with optional expiration
get	ygg.get(key)	Get value by key
delete	ygg.delete(key)	Delete a key
exists	ygg.exists(key)	Check if key exists
expire	ygg.expire(key, seconds)	Set expiration for key
ttl	ygg.ttl(key)	Get time to live for key
cache	ygg.cache(command, *args)	Execute any cache command
pipeline	ygg.pipeline()	Create pipeline for batch operations

Requirements

• Python 3.7+
• requests >= 2.25.0

Development

# Clone the repository
git clone https://github.com/Klug-Labs/ygg.git
cd ygg/clients/python

# Install in development mode
pip install -e .

# Run tests
python -m pytest tests/

License

MIT License - see LICENSE file for details.

Support

• Documentation: https://docs.ygg.com
• API Status: https://status.ygg.com
• Support Email: [e-mail]