openavaban

Python SDK for openavaban-api — image gallery and profile management.

No API keys or database credentials needed. Just install and use.

Installation

pip install openavaban

Quick Start

from openavaban import OpenavaBan

client = OpenavaBan()

# Upload an image
result = client.upload("photo.jpg", name="Profile Photo", class_type="avatar")
print(result["url"])

# Search images
results = client.search(class_type="avatar", category="profile")
for img in results["results"]:
    print(img["name"], img["url"])

# Get random images
random_imgs = client.random(category="profile", count=5)

# Get image by ID
image = client.get("image_id_here")

# Update image
client.update("image_id_here", name="New Name", tags=["new", "tag"])

# Delete image
client.delete("image_id_here")

# Bulk upload from CSV
result = client.bulk_upload("images.csv")
print(f"Uploaded {result['success']}/{result['total']}")

API Reference

OpenavaBan(base_url=None)

Create a client. Defaults to the hosted API at https://openavaban-api.giripratik.com.np.

client = OpenavaBan()  # uses hosted API
client = OpenavaBan(base_url="http://localhost:3000")  # local dev

Methods

Parameters

• file: File path string or file-like object
• class_type: "avatar" or "banner"
• category: Free-text category string
• tags: List of strings or comma-separated string
• mime_type: Filter by "image" or "gif"
• limit/max results: Capped at 100 for search, 20 for random

CSV Format (for bulk upload)

file_url,name,class_type,category,tags
https://example.com/photo1.jpg,Profile Photo,avatar,profile,"main,profile"
https://example.com/banner1.png,Social Banner,banner,social,"banner,v2"

Exceptions

License

MIT