Skip to main content

Reckomate Python SDK

Project description

🚀 Reckomate SDK

Reckomate SDK is an official Python SDK for securely interacting with the Reckomate backend platform.
It supports admin APIs, user APIs, MCQ workflows, Excel ingestion, scheduling, and gateway-based secure access.

This SDK is designed to be:

  • 🔐 Secure (gateway + project identity enforced)
  • 📦 Modular (service-based architecture)
  • 🚀 Production-ready
  • 🔄 Future-proof (easy to add new services)

📦 Installation

pip install recko-ai-sdk

⚙️ Quickstart (gateway)

1. Create the project folder,
        - Register with project name 
http://52.87.148.155:8000/project/register
 
2. Create the Virtual Environment 
	-  python -m venv reckovenv
 
3. Activate our Virtual Environment
        - .\reckovenv\Scripts\activate 

4. Install sdk with following with below command
	 # pip install recko-ai-sdk==1.0.7

5. create one file main.py with below code.
 
#main.py
import os
from fastapi import FastAPI, Request
from fastapi.responses import JSONResponse
from dotenv import load_dotenv
from reckomate_sdk.client import ReckomateClient
 
# Load .env
load_dotenv()
 
PROJECT_NAME = os.getenv("RECKOMATE_PROJECT_NAME")
MAIN_BACKEND = os.getenv("RECKOMATE_MAIN_BACKEND")
 
if not PROJECT_NAME:
    raise RuntimeError("RECKOMATE_PROJECT_NAME is missing in .env")
 
if not MAIN_BACKEND:
    raise RuntimeError("RECKOMATE_MAIN_BACKEND is missing in .env")
 
app = FastAPI(title=f"{PROJECT_NAME.upper()} Gateway")
 
# SDK low-level client
client = ReckomateClient(base_url=MAIN_BACKEND)
 
 
@app.get("/health")
def health():
    return {
        "status": "gateway-ok",
        "project": PROJECT_NAME
    }
 
 
@app.api_route("/{path:path}", methods=["GET", "POST", "PUT", "PATCH", "DELETE"])
async def proxy_all(path: str, request: Request):
    try:
        headers = dict(request.headers)
        headers.pop("host", None)
        headers.pop("content-length", None)
 
        # 🔐 Project identity (checked by gateway_guard.py)
        headers["x-internal-proxy"] = PROJECT_NAME
 
        body = await request.body()
 
        resp = client.proxy_request(
            method=request.method,
            path=f"/{path}",
            headers=headers,
            body=body,
            params=dict(request.query_params),
        )
 
        return JSONResponse(
            status_code=resp.status_code,
            content=resp.json() if resp.content else None
        )
 
    except Exception as e:
        return JSONResponse(
            status_code=500,
            content={
                "error": "GATEWAY_ERROR",
                "message": str(e)
            }
        )
 
 
6. Create .env file into project folder 

#.env 
# =====================================
# Project Identity (MANDATORY)
# MUST match the name registered via
# POST /project/register on main backend
# =====================================
RECKOMATE_PROJECT_NAME=inobeta
 
 
# =====================================
# Gateway URL (PUBLIC ENTRY POINT)
# Used by Postman / React Native / Flutter
# =====================================
RECKOMATE_GATEWAY_URL=http://52.87.148.155:5000

 
 
6. After that, needs to install three packages
          # pip install uvicorn fastapi dotenv
 
7. After run the project using command 
          # uvicorn main:app --host 0.0.0.0 --port 5000

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

recko_ai_sdk-1.0.7.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

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

recko_ai_sdk-1.0.7-py3-none-any.whl (14.8 kB view details)

Uploaded Python 3

File details

Details for the file recko_ai_sdk-1.0.7.tar.gz.

File metadata

  • Download URL: recko_ai_sdk-1.0.7.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for recko_ai_sdk-1.0.7.tar.gz
Algorithm Hash digest
SHA256 bc74a9772640862acc4fed70dab9847accad575527f6e234376610cdc2fa4b2f
MD5 12e3d0cd5e2c14b40596a0d7d4c424c7
BLAKE2b-256 1f3a568ee12cf1d45312a2eb9dd6e242f3329d94eba10366980957417e25f10e

See more details on using hashes here.

File details

Details for the file recko_ai_sdk-1.0.7-py3-none-any.whl.

File metadata

  • Download URL: recko_ai_sdk-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 14.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for recko_ai_sdk-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 877fb2502b10ddd9941e6aee0145f30cf8c54476cd8119b04765983431dadd20
MD5 80a07ed2eee28cdd6a14a25e6d9479c7
BLAKE2b-256 9b239d5f780d495bab80257465eb5037e59f5412227b221d0bebf58697a78a9b

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