claremont 0.1.0

A minimal Python SDK for the Claremont Computer Network API

Claremont

A minimal Python SDK for the Claremont Computer Network API.

Installation

pip install claremont

Quick Start

from claremont import Claremont

# Initialize with API key
client = Claremont(api_key="your-api-key")

# Login to get Bearer token
client.login()

# Verify token
client.verify()

# Make authenticated requests
response = client.get("/api/user/info")

# Logout
client.logout()

Configuration

Environment Variables

export CLAREMONT_API_KEY="your-api-key"
export CLAREMONT_BASE_URL="https://api.claremontcomputer.net"

Programmatic

client = Claremont(
    api_key="your-api-key",
    base_url="https://api.claremontcomputer.net",
    timeout=30.0
)

API Reference

Claremont

The main client class.

Parameters

• api_key (str, optional): API key for authentication. Can also set via CLAREMONT_API_KEY env var.
• base_url (str, optional): Base URL for the API. Defaults to https://api.claremontcomputer.net.
• timeout (float, optional): Request timeout in seconds. Defaults to 30.0.

Methods

login(api_key=None)

Login with API key and obtain a Bearer token.

client.login("your-api-key")
# Or use the one from constructor
client.login()

Returns: {"token": "...", "email": "..."}

logout()

Logout and invalidate the Bearer token.

client.logout()

Returns: {"message": "Logged out"}

register(email)

Register a new account. Note: Requires email verification on server.

client.register("[e-mail]")

Returns: {"status": "registered", "email": "..."}

get(path, **kwargs)

Make a GET request.

response = client.get("/api/user/info")

post(path, **kwargs)

Make a POST request.

response = client.post("/api/data", data={"key": "value"})

CLI Usage

# Show version
claremont -v

Examples

Full Authentication Flow

from claremont import Claremont

# Initialize
client = Claremont(api_key="your-api-key")

# Login
result = client.login()
print(f"Logged in as: {result['email']}")

# Make authenticated request
user_info = client.get("/api/user/info")
print(user_info)

# Logout
client.logout()

Using Context Manager

from claremont import Claremont

with Claremont(api_key="your-api-key") as client:
    client.login()
    response = client.get("/api/user/info")
    # Token automatically invalidated on exit

Register New User

from claremont import Claremont

client = Claremont(api_key="admin-api-key")
client.register("[e-mail]")

CLI Usage

# Register a new account
claremont register [e-mail]

# Login
claremont login [e-mail]

# Logout (requires token from login)
claremont logout -t YOUR_TOKEN

# Specify custom URL
claremont --url https://api.claremontcomputer.net login [e-mail]

Requirements

• Python 3.7+
• No external dependencies (uses stdlib only)

License

GPL-3.0