Weatherstack Python SDK 1.0.0

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

Versions

• API version: 1.0.0
• SDK version: 1.0.0

About the API

Quick Start Guide ## Step 1: Your API Access Key To get started quickly, you need to fork the MarketStack Postman Collection. Simply click the button below to fork it. ### Step 2: Get your API Access Key 1. Go to the Weatherstack website and choose the right subscription plan for your particular project. 2. Get your personal API Access Key on the Dashboard to authenticate with the API. Keep it safe! You can reset it at any time in your Account Dashboard. ## Step 3: Make your first API call Weatherstack Postman collection contains all the endpoints supported by Weatherstack API. 1. Current weather data 2. Historical weather data 3. Weather forecast 4. Autocomplete/Location lookup

Table of Contents

• Setup & Configuration
  • Supported Language Versions
  • Installation
• Using Union Types
• Services
• Models
• License

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 weatherstack-client

Using Union Types

Union types allow you to specify that a variable can have more than one type. This is particularly useful when a function can accept multiple types of inputs. The Union type hint is used for this purpose.

Example Function with Union Types

You can call service method with an instance of TypeA, TypeB, or a dictionary that can be converted to an instance of either type.

# Model Definition
ParamType = Union[TypeA, TypeB]

# Service Method
def service_method(param: ParamType):
...

## Usage
type_a = TypeA(key="value")
type_b = TypeB(key="value")

sdk.service.service_method(type_a)
sdk.service.service_method(type_b)
sdk.service.service_method({"key": "value"})

You cannot create an instance of a Union type itself. Instead, pass an instance of one of the types in the Union, or a dictionary that can be converted to one of those types.

Services

The SDK provides various services to interact with the API.

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.

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.