Object Store API and Client

A simple object storage system with a FastAPI backend and Python client. The system provides a REST API for storing and retrieving binary objects, with support for pagination, prefix filtering, and proper error handling.

Features

• Simple key-value object storage
• RESTful API with FastAPI backend
• Python client with retry logic and connection pooling
• Support for pagination when listing objects
• Proper error handling and status codes
• Rate limiting support
• API key authentication

Installation

pip install -r requirements.txt

Quick Start Guide

Using the Python Client

The RestStore client provides a simple interface for interacting with the object store:

from client import RestStore

# Initialize the client
store = RestStore.create(
    base_url='http://localhost:8000',
    api_key='your-api-key'
)

# Store an object
store.put('my-key', b'Hello, World!')

# Check if an object exists
if store.exists('my-key'):
    # Retrieve an object
    data = store.get('my-key')
    print(data.decode())  # Hello, World!

# Delete an object
store.delete('my-key')

# List all objects (with automatic pagination)
for key in store.keys():
    print(key)

Using the Context Manager

For better resource management, you can use the client as a context manager:

with RestStore.create(base_url='http://localhost:8000', api_key='your-api-key') as store:
    store.put('temp-key', b'temporary data')
    data = store.get('temp-key')
    # Connection is automatically closed after the context

Client Configuration Options

When initializing the client, you can configure several parameters:

store = RestStore.create(
    base_url='http://localhost:8000',
    api_key='your-api-key',
    timeout=30.0,        # Request timeout in seconds
    max_retries=3,       # Maximum number of retry attempts
    retry_delay=1.0      # Initial delay between retries (doubles after each attempt)
)

Error Handling

The client provides proper error handling through exceptions:

try:
    data = store.get('nonexistent-key')
except KeyError as e:
    print(f"Object not found: {e}")

try:
    for key in store.keys():
        print(key)
except NotImplementedError as e:
    print(f"Listing keys not supported: {e}")

Running the Server

Start the FastAPI server using uvicorn:

uvicorn app:app --host 0.0.0.0 --port 8000

Running Tests

The project includes a comprehensive test suite:

pytest test.py

API Endpoints

• PUT /objects/{key} - Store an object
• GET /objects/{key} - Retrieve an object
• HEAD /objects/{key} - Check if an object exists
• DELETE /objects/{key} - Delete an object
• GET /objects - List objects (supports pagination and prefix filtering)

Note that keys with special characters must be URL-encoded and decoded. This is handled automatically by the client and server-side implementations.