folioman-client

Official typed asynchronous Python SDK for the Folioman REST API.

The folioman-client library provides an asynchronous, strongly typed interface for interacting with Folioman services. It handles HTTP communication, JWT authentication lifecycles, proactive and reactive token refresh, concurrent locking, and response mapping into Pydantic models.

Key Features

• Asynchronous Transport: Built on top of httpx.AsyncClient with native HTTP/2 and connection pooling.
• Automated JWT Lifecycle: Obtains initial tokens from /api/auth/token/pair, automatically refreshes via /api/auth/token/refresh, and transparently retries requests on HTTP 401.
• Concurrency-Safe Token Refresh: Utilizes an internal asyncio.Lock to guarantee that only one concurrent refresh request runs at any time.
• Proactive Expiry Absorption: Evaluates token expiry using an embedded payload decoder and proactively refreshes 30 seconds before actual token expiration (EXP_SKEW_SECONDS = 30).
• Typed Response Parsing: Parses JSON payloads into Pydantic v2 models that handle Decimal serializations and ignore unknown extra attributes for forward-compatibility.
• Structured Exception Hierarchy: Maps HTTP status codes into specific client exceptions (FoliomanAuthError, FoliomanNotFoundError, FoliomanAPIError).

Prerequisites

This client depends on a running instance of the Folioman service:

• A running Folioman backend server (default URL: http://localhost:8000, or configured via FOLIOMAN_BASE_URL / base_url).
• Valid advisor / user credentials (username and password) configured on the Folioman service.

Installation

pip install folioman-client

Or using uv:

uv add folioman-client

Quickstart

It is strongly recommended to use FoliomanClient as an asynchronous context manager:

import asyncio
from folioman_client import FoliomanClient


async def main() -> None:
    # Uses FOLIOMAN_BASE_URL, FOLIOMAN_USERNAME, FOLIOMAN_PASSWORD from environment
    async with FoliomanClient.from_env() as client:
        # Fetch accessible investors
        investors = await client.investors.list()
        for investor in investors:
            print(f"Investor: {investor.name} (ID: {investor.id})")

            # Fetch portfolio summary
            summary = await client.portfolio.get(investor.id)
            print(f"  Total Portfolio Value: INR {summary.total_inr:,.2f}")
            print(f"  XIRR: {summary.xirr * 100:.2f}%" if summary.xirr else "  XIRR: N/A")


if __name__ == "__main__":
    asyncio.run(main())

Client Initialization

The client can be instantiated in three ways:

1. From Environment Variables (from_env)

Automatically loads configuration from environment variables or .env file using the FOLIOMAN_ prefix:

from folioman_client import FoliomanClient

client = FoliomanClient.from_env()

Supported environment variables:

• FOLIOMAN_BASE_URL: API service endpoint (default: http://localhost:8000)
• FOLIOMAN_USERNAME: Advisor username
• FOLIOMAN_PASSWORD: Advisor password
• FOLIOMAN_TIMEOUT: Request timeout in seconds (default: 30.0)

2. Directly with Arguments

from folioman_client import FoliomanClient

client = FoliomanClient(
    base_url="http://localhost:8000",
    username="advisor",
    password="supersecretpassword",
    timeout=30.0,
)

3. From a FoliomanSettings Instance

from folioman_client import FoliomanClient, FoliomanSettings

settings = FoliomanSettings(
    base_url="http://localhost:8000",
    username="advisor",
    password="supersecretpassword",
)
client = FoliomanClient.from_settings(settings)

Resource Sub-Clients

FoliomanClient exposes its API through organized resource sub-clients:

Error Handling

All client exceptions derive from FoliomanError:

from folioman_client import (
    FoliomanClient,
    FoliomanAuthError,
    FoliomanNotFoundError,
    FoliomanAPIError,
)

async with FoliomanClient.from_env() as client:
    try:
        investor = await client.investors.get(99999)
    except FoliomanNotFoundError:
        print("Investor does not exist.")
    except FoliomanAuthError as exc:
        print(f"Authentication failed: {exc}")
    except FoliomanAPIError as exc:
        print(f"Status Code: {exc.status_code}")
        print(f"Error Details: {exc.response_data}")

Documentation

Full documentation is available at: https://sid-146.github.io/folioman-client/

To build documentation locally:

uv sync --group dev
uv run mkdocs serve

License

This project is licensed under the MIT License - see the LICENSE file for details.