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.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

avri_api-0.1.8-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file avri_api-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: avri_api-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0.post20201207 requests-toolbelt/0.9.1 tqdm/4.55.1 CPython/3.7.9

File hashes

Hashes for avri_api-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 40274bfacd140895a7f2c6c5f27478b0a31c21aa1a6e8767fdbc77f05a186c31
MD5 9895d36a492ba442f96118577788a54e
BLAKE2b-256 6b13a7241513b392dd41398668f1ede5968151a06cd97e3a2169e4a10286dc1f

See more details on using hashes here.

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