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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file ambient_api-1.5.7.tar.gz.

File metadata

  • Download URL: ambient_api-1.5.7.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.12

File hashes

Hashes for ambient_api-1.5.7.tar.gz
Algorithm Hash digest
SHA256 4a72a5b6552298ad34510f122b09d2e25acfad27c8b92e1f8ae0d8d66e48c100
MD5 ee44bfa591b1c34841b0900542c442cd
BLAKE2b-256 a309b22a851d0fd1cb5d318eaca10a398e6ba023731f728133bcc50f875fc634

See more details on using hashes here.

Provenance

File details

Details for the file ambient_api-1.5.7-py3-none-any.whl.

File metadata

  • Download URL: ambient_api-1.5.7-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.10.12

File hashes

Hashes for ambient_api-1.5.7-py3-none-any.whl
Algorithm Hash digest
SHA256 1ae28f5785b0c2e24a74a424682bdf83a6acc54a91855f5c50ccb8ecc324844c
MD5 a079175884d743267832a485a6b2396c
BLAKE2b-256 d53d3c30fb74bb1bda69be919cadc59a0fb7b3287b0ff2485ce38b4b1123f83a

See more details on using hashes here.

Provenance

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