Skip to main content

Unofficial wrapper around Avri endpoints

Project description

Python Avri API

Build Status PyPI

Unofficial wrapper around the Avri API, for automation purposes.

Usage

pip install avri-api

Initialize the client with you postal code and house number. Optionally provide a house_nr_extension and/or a country_code.

from avri.api import Avri
client = Avri('1234AB', 42)

Exposes the following functions:

  • client.upcoming() returns first upcoming collecting day in a Garbage object
  • client.upcoming_of_each() returns first upcoming collecting day for each garbage type in a List[Garbage] object
  • client.all() returns all upcoming collecting days in a List[Garbage] object

Both upcoming and upcoming_of_each contain today's pickup.

The Garbage object

Contains

  • name: The name of the garbage type, e.g. plastic or gft.
  • day: A python datetime object representing the collecting date.

In a long living process

Data is cached for 6 days before it's refreshed to reduce the number of API calls made.

Project details


Download files

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

Files for avri-api, version 0.1.5
Filename, size File type Python version Upload date Hashes
Filename, size avri_api-0.1.5-py3-none-any.whl (3.9 kB) File type Wheel Python version py3 Upload date Hashes View hashes

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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page