Skip to main content

Asynchronous Python client for Twente Milieu API.

Project description

Python: Twente Milieu

GitHub Release Python Versions Project Stage Project Maintenance License

Build Status Code Coverage Quality Gate Status Open in Dev Containers

Sponsor Frenck via GitHub Sponsors

Support Frenck on Patreon

Asynchronous Python client for the Twente Milieu API.

About

This package allows you to request waste pickup days from Twente Milieu programmatically. It is mainly created to allow third-party programs to use or respond to this data.

An excellent example of this might be Home Assistant, which allows you to write automations, e.g., play a Google Home announcement in the morning when it is trash pickup day.

Installation

pip install twentemilieu

Usage

import asyncio

from twentemilieu import TwenteMilieu, WasteType


async def main() -> None:
    """Show example on stats from Twente Milieu."""
    async with TwenteMilieu(post_code="1234AB", house_number=1) as twente:
        unique_id = await twente.unique_id()
        print("Unique Address ID:", unique_id)
        pickups = await twente.update()
        print("Next pickup for Non-recyclable:", pickup.get(WasteType.NON_RECYCLABLE))


if __name__ == "__main__":
    asyncio.run(main())

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! :heart_eyes:

Setting up development environment

The easiest way to start, is by opening a CodeSpace here on GitHub, or by using the Dev Container feature of Visual Studio Code.

Open in Dev Containers

This Python project is fully managed using the Poetry dependency manager. But also relies on the use of NodeJS for certain checks during development.

You need at least:

  • Python 3.11+
  • Poetry
  • NodeJS 20+ (including NPM)

To install all packages, including all development requirements:

npm install
poetry install

As this repository uses the pre-commit framework, all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

poetry run pre-commit run --all-files

To run just the Python tests:

poetry run pytest

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Copyright (c) 2019-2025 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

twentemilieu-2.2.1.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

twentemilieu-2.2.1-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file twentemilieu-2.2.1.tar.gz.

File metadata

  • Download URL: twentemilieu-2.2.1.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for twentemilieu-2.2.1.tar.gz
Algorithm Hash digest
SHA256 6bc8fac667fb20bfaba81e634139f7de9f13686750e66417b63377e8db1e52a1
MD5 22d5e996c26d6798e063057222bbf49e
BLAKE2b-256 7cbe959469a87554c504014c7c1c7bfd9c3e7cf719a4dce93a8e8bc2121e9dec

See more details on using hashes here.

Provenance

The following attestation bundles were made for twentemilieu-2.2.1.tar.gz:

Publisher: release.yaml on frenck/python-twentemilieu

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file twentemilieu-2.2.1-py3-none-any.whl.

File metadata

  • Download URL: twentemilieu-2.2.1-py3-none-any.whl
  • Upload date:
  • Size: 8.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for twentemilieu-2.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 87759a358046e64bf0a010c5ab7a51de90ee9949773cc05f59efa720c53a4329
MD5 e727224030a13041a75ca4cb2cce7e95
BLAKE2b-256 0f017a304c34ac85f3109cce4f45134ab08615f37ecd7d09b7c0a6023acfed71

See more details on using hashes here.

Provenance

The following attestation bundles were made for twentemilieu-2.2.1-py3-none-any.whl:

Publisher: release.yaml on frenck/python-twentemilieu

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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