Client

The main client for interacting with the T2G API.

The T2GClient is the primary interface for interacting with the T2G API. It handles authentication, session management, and provides access to the various services.

Initialization

The client is best used as an asynchronous context manager.

import asyncio
from t2g_sdk import T2GClient

async def main():
    async with T2GClient() as client:
        # Use the client to access services
        pass

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

Configuration

The T2GClient utilizes Pydantic's BaseSettings for its configuration, allowing for flexible parameter management. Settings are loaded in a specific order of precedence:

  1. Environment variables: Values set directly in the environment take the highest precedence (e.g., export LETTRIA_API_KEY="your_key").
  2. .env file: A .env file located in the project root (where the SDK is run) will be loaded. This is a convenient way to manage local development settings without committing them to version control.
  3. Default values: If a setting is not found in environment variables or a .env file, the SDK will use its predefined default values.

Here are the available configuration parameters:

ParameterTypeDefault ValueDescription
LETTRIA_API_KEYstr(required)Your Lettria API key for authentication.
NEO4J_URIstrbolt://localhost:7687The URI for your Neo4j database connection.
NEO4J_USERstrneo4jThe username for authenticating with Neo4j.
NEO4J_PASSWORDstrpasswordThe password for authenticating with Neo4j.
LOGLEVELstrWARNINGThe logging level for the SDK (e.g., DEBUG, INFO, WARNING, ERROR).

Services

Once the client is initialized, you can access the various services as properties of the client instance: