Skip to main content

A Python class for accessing the Ambient Weather API.

Project description

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://rt.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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ambient_api-1.5.7.tar.gz (4.7 kB view hashes)

Uploaded Source

Built Distribution

ambient_api-1.5.7-py3-none-any.whl (5.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page