edurra 1.0.3

Maiaddy Cloud Essence Edurra platform for educational planning and resource management

Edurra Python SDK 1.0.3

Welcome to the Edurra SDK documentation. This guide will help you get started with integrating and using the Edurra SDK in your project.

Versions

• API version: 1.0.3
• SDK version: 1.0.3

About the API

Edurra API for Educational Planning and Resource Management. Powered by postcode-based intelligence and Loccode integration.

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • Access Token Authentication
• Setting a Custom Timeout
• Sample Usage
• Services
• Models

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install edurra

If you are using Python 3, you can use pip3 instead:

pip3 install edurra

Authentication

Access Token Authentication

The EdurraSdk API uses an Access Token for authentication.

This token must be provided to authenticate your requests to the API.

Setting the Access Token

When you initialize the SDK, you can set the access token as follows:

EdurraSdk(
    access_token="YOUR_ACCESS_TOKEN",
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)

If you need to set or update the access token after initializing the SDK, you can use:

sdk.set_access_token("YOUR_ACCESS_TOKEN")

Setting a Custom Timeout

You can set a custom timeout for the SDK's HTTP requests as follows:

from edurra_sdk import EdurraSdk

sdk = EdurraSdk(timeout=10000)

Sample Usage

Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:

from edurra_sdk import EdurraSdk

sdk = EdurraSdk(
    access_token="YOUR_ACCESS_TOKEN",
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)

result = sdk.health.health_check()

print(result)

Async Usage

The SDK includes an Async Client for making asynchronous API requests. This is useful for applications that need non-blocking operations, like web servers or apps with a graphical user interface.

import asyncio
from edurra_sdk import EdurraSdkAsync

sdk = EdurraSdkAsync(
    access_token="YOUR_ACCESS_TOKEN",
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)


async def main():
  result = await sdk.health.health_check()
  print(result)

asyncio.run(main())

Services

The SDK provides various services to interact with the API.

Below is a list of all available services:

Name
school_discovery
demographic_insights
catchment_area_analysis
transportation_planning
health

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models:

Name	Description
GetSchoolsRequestDto
GetDemographicsRequestDto
GetCatchmentRequestDto
CurateBusRouteRequestDto