Metadata-Version: 2.4 Name: aioridwell Version: 2025.9.0 Summary: A Python3, asyncio-based API for interacting with Ridwell waste recycling License: MIT License-File: LICENSE Author: Aaron Bach Author-email: bachya1208@gmail.com Requires-Python: >=3.10,<4.0 Classifier: License :: OSI Approved :: MIT License Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.10 Classifier: Programming Language :: Python :: 3.11 Classifier: Programming Language :: Python :: 3.12 Classifier: Programming Language :: Python :: 3.13 Classifier: Programming Language :: Python :: 3.14 Classifier: Programming Language :: Python :: Implementation :: CPython Classifier: Programming Language :: Python :: Implementation :: PyPy Requires-Dist: PyJWT (>=2.4.0) Requires-Dist: aiohttp (>=3.9.0b0) Requires-Dist: certifi (>=2023.07.22) Requires-Dist: titlecase (>=2.3,<3.0) Requires-Dist: yarl (>=1.9.2) Project-URL: Bug Tracker, https://github.com/bachya/aioridwell/issues Project-URL: Changelog, https://github.com/bachya/aioridwell/releases Project-URL: Repository, https://github.com/bachya/aioridwell Description-Content-Type: text/markdown # ♻️ aioridwell: A Python3, asyncio-based API for interacting with Ridwell [![CI][ci-badge]][ci] [![PyPI][pypi-badge]][pypi] [![Version][version-badge]][version] [![License][license-badge]][license] [![Code Coverage][codecov-badge]][codecov] [![Maintainability][maintainability-badge]][maintainability]

`aioridwell` is a Python 3, asyncio-friendly library for interacting with [Ridwell][ridwell] to view information on upcoming recycling pickups. - [Installation](#installation) - [Python Versions](#python-versions) - [Usage](#usage) - [Contributing](#contributing) # Installation ```bash pip install aioridwell ``` # Python Versions `aioridwell` is currently supported on: - Python 3.10 - Python 3.11 - Python 3.12 # Usage ## Creating and Using a Client The `Client` is the primary method of interacting with the API: ```python import asyncio from aioridwell import async_get_client async def main() -> None: client = await async_get_client("", "") # ... asyncio.run(main()) ``` By default, the library creates a new connection to the API with each coroutine. If you are calling a large number of coroutines (or merely want to squeeze out every second of runtime savings possible), an [`aiohttp`][aiohttp] `ClientSession` can be used for connection pooling: ```python import asyncio from aiohttp import ClientSession from aiowatttime import Client async def main() -> None: async with ClientSession() as session: client = await async_get_client("", "", session=session) # ... asyncio.run(main()) ``` ## Getting the User's Dashboard URL ```python import asyncio from aioridwell import async_get_client async def main() -> None: client = await async_get_client("", "") client.get_dashboard_url() # >>> https://www.ridwell.com/users/userId1/dashboard asyncio.run(main()) ``` ## Getting Accounts Getting all accounts associated with this email address is easy: ```python import asyncio from aioridwell import async_get_client async def main() -> None: client = await async_get_client("", "") accounts = await client.async_get_accounts() # >>> {"account_id_1": RidwellAccount(...), ...} asyncio.run(main()) ``` The `RidwellAccount` object comes with some useful properties: - `account_id`: the Ridwell ID for the account - `address`: the address being serviced - `email`: the email address on the account - `full_name`: the full name of the account owner - `phone`: the phone number of the account owner - `subscription_id`: the Ridwell ID for the primary subscription - `subscription_active`: whether the primary subscription is active ## Getting Pickup Events Getting pickup events associated with an account is easy, too: ```python import asyncio from aioridwell import async_get_client async def main() -> None: client = await async_get_client("", "") accounts = await client.async_get_accounts() for account in accounts.values(): events = await account.async_get_pickup_events() # >>> [RidwellPickupEvent(...), ...] # You can also get just the next pickup event from today's date: next_event = await account.async_get_next_pickup_event() # >>> RidwellPickupEvent(...) asyncio.run(main()) ``` The `RidwellPickupEvent` object comes with some useful properties: - `pickup_date`: the date of the pickup (in `datetime.date` format) - `pickups`: a list of `RidwellPickup` objects - `state`: an `EventState` enum whose name represents the current state of the pickup event Likewise, the `RidwellPickup` object comes with some useful properties: - `category`: a `PickupCategory` enum whose name represents the type of pickup - `name`: the name of the item being picked up - `offer_id`: the Ridwell ID for this particular offer - `priority`: the pickup priority - `product_id`: the Ridwell ID for this particular product - `quantity`: the amount of the product being picked up ### Opting Into or Out Of a Pickup Event ```python import asyncio from aioridwell import async_get_client async def main() -> None: client = await async_get_client("", "") accounts = await client.async_get_accounts() for account in accounts.values(): events = await account.async_get_pickup_events() # >>> [RidwellPickupEvent(...), ...] await events[0].async_opt_in() await events[0].async_opt_out() asyncio.run(main()) ``` ### Calculating a Pickup Event's Estimated Add-on Cost ```python import asyncio from aioridwell import async_get_client async def main() -> None: client = await async_get_client("", "") accounts = await client.async_get_accounts() for account in accounts.values(): events = await account.async_get_pickup_events() # >>> [RidwellPickupEvent(...), ...] event_1_cost = await events[0].async_get_estimated_addon_cost() # >>> 22.00 asyncio.run(main()) ``` # Contributing Thanks to all of [our contributors][contributors] so far! 1. [Check for open features/bugs][issues] or [initiate a discussion on one][new-issue]. 2. [Fork the repository][fork]. 3. (_optional, but highly recommended_) Create a virtual environment: `python3 -m venv .venv` 4. (_optional, but highly recommended_) Enter the virtual environment: `source ./.venv/bin/activate` 5. Install the dev environment: `script/setup` 6. Code your new feature or bug fix on a new branch. 7. Write tests that cover your new functionality. 8. Run tests and ensure 100% code coverage: `poetry run pytest --cov aioridwell tests` 9. Update `README.md` with any new documentation. 10. Submit a pull request! [aiohttp]: https://github.com/aio-libs/aiohttp [ci-badge]: https://img.shields.io/github/actions/workflow/status/bachya/aioridwell/test.yml [ci]: https://github.com/bachya/aioridwell/actions [codecov-badge]: https://codecov.io/gh/bachya/aioridwell/branch/dev/graph/badge.svg [codecov]: https://codecov.io/gh/bachya/aioridwell [contributors]: https://github.com/bachya/aioridwell/graphs/contributors [fork]: https://github.com/bachya/aioridwell/fork [issues]: https://github.com/bachya/aioridwell/issues [license-badge]: https://img.shields.io/pypi/l/aioridwell.svg [license]: https://github.com/bachya/aioridwell/blob/main/LICENSE [maintainability-badge]: https://api.codeclimate.com/v1/badges/9c1dcc1c991cecb06eda/maintainability [maintainability]: https://codeclimate.com/github/bachya/aioridwell/maintainability [new-issue]: https://github.com/bachya/aioridwell/issues/new [new-issue]: https://github.com/bachya/aioridwell/issues/new [pypi-badge]: https://img.shields.io/pypi/v/aioridwell.svg [pypi]: https://pypi.python.org/pypi/aioridwell [ridwell]: https://ridwell.com [version-badge]: https://img.shields.io/pypi/pyversions/aioridwell.svg [version]: https://pypi.python.org/pypi/aioridwell