avryhof / ambient_api

Python module for accessing the Ambient Weather API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PyPI version Build Status codecov CodeFactor

Ambient API

Python Module to access the Ambient Weather API

Installation

pip install ambient_api

Environmental Variables

AMBIENT_ENDPOINT=https://api.ambientweather.net/v1
AMBIENT_API_KEY='your-api-key-here'
AMBIENT_APPLICATION_KEY='your-application-key-here'

Get these values by following these instructions.

Still struggling, check out the Authentication documentation in my Postman Collection repo.

Classes

There are two classes implemented in this module.

AmbientAPI

This is the base API that you initialize in your code.

from ambient_api.ambientapi import AmbientAPI
import time

api = AmbientAPI()

This class takes care of authenticating to, and sending calls to the API. It can be expanded as needed in the future.

AmbientWeatherStation

This class represents a single Weather Station. When you ask AmbientAPI for a list of devices, it returns a list of AmbientWeatherStations, and from this class, you can query the weather station itself.

devices = api.get_devices()

device = devices[0]

time.sleep(1) #pause for a second to avoid API limits

print(device.get_data())

Learn more about the Ambient Weather API at the Ambient Weather API Documentation.

Also Check Out

About

Python module for accessing the Ambient Weather API

License:MIT License


Languages

Language:Python 96.6%Language:Shell 3.4%