agriflux 1.0.1

Maiaddy Cloud Essence Agriflux platform for agricultural intelligence and supply chain optimization

Agriflux Python SDK 1.0.1

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

Versions

• API version: 1.0.1
• SDK version: 1.0.1

About the API

Maiaddy Cloud Essence Agriflux platform for agricultural intelligence and supply chain optimization

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Authentication
  • API Key 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 agriflux

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

pip3 install agriflux

Authentication

API Key Authentication

The AgrifluxSdk API uses an API Key for authentication.

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

Setting the API Key

When you initialize the SDK, you can set the API key as follows:

AgrifluxSdk(
    access_token="YOUR_API_KEY",
    timeout=10000
)

If you need to set or update the API key after initializing the SDK, you can use:

sdk.set_access_token("YOUR_API_KEY")

Setting a Custom Timeout

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

from agriflux_sdk import AgrifluxSdk

sdk = AgrifluxSdk(timeout=10000)

Sample Usage

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

from agriflux_sdk import AgrifluxSdk

sdk = AgrifluxSdk(
    access_token="YOUR_API_KEY",
    timeout=10000
)

result = sdk.health_controller.health()

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 agriflux_sdk import AgrifluxSdkAsync

sdk = AgrifluxSdkAsync(
    access_token="YOUR_API_KEY",
    timeout=10000
)


async def main():
  result = await sdk.health_controller.health()
  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
yield_prediction
pest_disease_monitoring
supply_chain_optimization
health_controller
soil_climate_data

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
SupplyFarmProduceRequestDto