Skip to main content

A clean, async-friendly library for the Ambient Weather API

Project description

🌤 aioambient: An async library for Ambient Weather Personal Weather Stations

Travis CI PyPi Version License Code Coverage Maintainability Say Thanks

aioambient is a Python3, asyncio-driven library that interfaces with both the REST and Websocket APIs provided by Ambient Weather.

Installation

pip install aioambient

Python Versions

aioambient is currently supported on:

  • Python 3.5
  • Python 3.6
  • Python 3.7

However, running the test suite currently requires Python 3.6 or higher; tests run on Python 3.5 will fail.

API and Application Keys

Utilizing aioambient requires both an Application Key and an API Key from Ambient Weather. You can generate both from the Profile page in your Ambient Weather Dashboard.

Usage

Creating a Client

An aioambient client starts with an aiohttp ClientSession:

import asyncio

from aiohttp import ClientSession

from aioambient import Client


async def main() -> None:
    """Create the aiohttp session and run the example."""
    async with ClientSession() as websession:
      # YOUR CODE HERE


asyncio.get_event_loop().run_until_complete(main())

Create a client, initialize it, then get to it:

import asyncio

from aiohttp import ClientSession

from aioambient import Client


async def main() -> None:
    """Create the aiohttp session and run the example."""
    async with ClientSession() as websession:
      client = Client(
        '<YOUR API KEY>',
        '<YOUR APPLICATION KEY>',
        websession)


asyncio.get_event_loop().run_until_complete(main())

REST API

import asyncio

from aiohttp import ClientSession

from aioambient import Client


async def main() -> None:
    """Create the aiohttp session and run the example."""
    async with ClientSession() as websession:
      client = Client(
        '<YOUR API KEY>',
        '<YOUR APPLICATION KEY>',
        websession)

      # Get all devices in an account:
      await client.api.get_devices()

      # Get all stored readings from a device:
      await client.api.get_device_details('<DEVICE MAC ADDRESS>')

      # Get all stored readings from a device (starting at a datetime):
      await client.api.get_device_details(
        '<DEVICE MAC ADDRESS>', end_date="2019-01-16")


asyncio.get_event_loop().run_until_complete(main())

Please be aware of Ambient Weather's rate limiting policies.

Websocket API

import asyncio

from aiohttp import ClientSession

from aioambient import Client


async def main() -> None:
    """Create the aiohttp session and run the example."""
    async with ClientSession() as websession:
      client = Client(
        '<YOUR API KEY>',
        '<YOUR APPLICATION KEY>',
        websession)

      # Define a method (sync or async) that should be run when the websocket
      # client connects:
      def connect_method():
          """Print a simple "hello" message."""
          print('Client has connected to the websocket')
      client.websocket.on_connect(connect_method)

      # Define a method (sync or async) that should be run upon subscribing to
      # the Ambient Weather cloud:
      def subscribed_method(data):
          """Print the data received upon subscribing."""
          print('Subscription data received: {0}'.format(data))
      client.websocket.on_subscribed(subscribed_method)

      # Define a method (sync or async) that should be run upon receiving data:
      def data_method(data):
          """Print the data received."""
          print('Data received: {0}'.format(data))
      client.websocket.on_data(data_method)

      # Define a method (sync or async) that should be run when the websocket
      # client disconnects:
      def disconnect_method(data):
          """Print a simple "goodbye" message."""
          print('Client has disconnected from the websocket')
      client.websocket.on_disconnect(disconnect_method)

      # Connect to the websocket:
      await client.websocket.connect()

      # At any point, disconnect from the websocket:
      await client.websocket.disconnect()


loop = asyncio.get_event_loop()
loop.create_task(main())
loop.run_forever()

Contributing

  1. Check for open features/bugs or initiate a discussion on one.
  2. Fork the repository.
  3. Install the dev environment: make init.
  4. Enter the virtual environment: pipenv shell
  5. Code your new feature or bug fix.
  6. Write a test that covers your new functionality.
  7. Run tests and ensure 100% code coverage: make coverage
  8. Add yourself to AUTHORS.md.
  9. Submit a pull request!

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
aioambient-0.1.3-py3-none-any.whl (8.2 kB) Copy SHA256 hash SHA256 Wheel py3
aioambient-0.1.3.tar.gz (6.8 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page