Skip to main content

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

Project description

Kachy Valkey Python Client

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

Installation

pip install kachy-valkey

Quick Start

import os
import kachy

# Initialize with your access key
kachy.init(os.environ.get("KACHY_ACCESS_KEY"))

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

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

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

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

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

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

# Close connection
kachy.close()

Advanced Operations

Custom Valkey Commands

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

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

Pipeline Operations

# Batch operations for better performance
with kachy.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:

  • KACHY_ACCESS_KEY: Your authentication access key (required)
  • KACHY_BASE_URL: API base URL (default: https://cache.kluglabs.net)
  • KACHY_TIMEOUT: Request timeout in seconds (default: 30)
  • KACHY_MAX_RETRIES: Maximum retry attempts (default: 3)
  • KACHY_RETRY_DELAY: Delay between retries in seconds (default: 1.0)
  • KACHY_POOL_SIZE: Connection pool size (default: 10)

API Reference

Operation Method Description
set kachy.set(key, value, ex?) Set key-value pair with optional expiration
get kachy.get(key) Get value by key
delete kachy.delete(key) Delete a key
exists kachy.exists(key) Check if key exists
expire kachy.expire(key, seconds) Set expiration for key
ttl kachy.ttl(key) Get time to live for key
valkey kachy.valkey(command, *args) Execute any Valkey command
pipeline kachy.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/kachy-valkey-python.git
cd kachy-valkey-python

# Install in development mode
pip install -e .

# Run tests
python -m pytest tests/

License

MIT License - see LICENSE file for details.

Support

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kachy_valkey-0.1.9.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kachy_valkey-0.1.9-py3-none-any.whl (8.0 kB view details)

Uploaded Python 3

File details

Details for the file kachy_valkey-0.1.9.tar.gz.

File metadata

  • Download URL: kachy_valkey-0.1.9.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.10

File hashes

Hashes for kachy_valkey-0.1.9.tar.gz
Algorithm Hash digest
SHA256 60402ba5ce0fc7eae5f15b77de93abd1e298249adc4fdcb9f8883e159d9eb6ea
MD5 3ab62ef62a369264a6f79a028f5bcfd7
BLAKE2b-256 33bf733dce08a869437abb967475fcbf6bb535cb1013df1a7c850defbf52be90

See more details on using hashes here.

File details

Details for the file kachy_valkey-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: kachy_valkey-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 8.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.10

File hashes

Hashes for kachy_valkey-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 76f5d2f40cdfcd21401007796790eb15852a3554634946dc5cd41eb68cdc1322
MD5 df01a2c613e00fe8e1ddff0a299e5817
BLAKE2b-256 e21dc8d1defd80a4f84c651d024c3fa841c086622c3888acbf9623fe306b94ba

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page