aioridwell is a Python 3, asyncio-friendly library for interacting with
Ridwell to view information on upcoming recycling pickups.
pip install aioridwellaioridwell is currently supported on:
- Python 3.10
- Python 3.11
- Python 3.12
The Client is the primary method of interacting with the API:
import asyncio
from aioridwell import async_get_client
async def main() -> None:
client = await async_get_client("<EMAIL>", "<PASSWORD>")
# ...
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 ClientSession can be used for
connection pooling:
import asyncio
from aiohttp import ClientSession
from aiowatttime import Client
async def main() -> None:
async with ClientSession() as session:
client = await async_get_client("<EMAIL>", "<PASSWORD>", session=session)
# ...
asyncio.run(main())import asyncio
from aioridwell import async_get_client
async def main() -> None:
client = await async_get_client("<EMAIL>", "<PASSWORD>")
client.get_dashboard_url()
# >>> https://www.ridwell.com/users/userId1/dashboard
asyncio.run(main())Getting all accounts associated with this email address is easy:
import asyncio
from aioridwell import async_get_client
async def main() -> None:
client = await async_get_client("<EMAIL>", "<PASSWORD>")
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 accountaddress: the address being servicedemail: the email address on the accountfull_name: the full name of the account ownerphone: the phone number of the account ownersubscription_id: the Ridwell ID for the primary subscriptionsubscription_active: whether the primary subscription is active
Getting pickup events associated with an account is easy, too:
import asyncio
from aioridwell import async_get_client
async def main() -> None:
client = await async_get_client("<EMAIL>", "<PASSWORD>")
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 (indatetime.dateformat)pickups: a list ofRidwellPickupobjectsstate: anEventStateenum whose name represents the current state of the pickup event
Likewise, the RidwellPickup object comes with some useful properties:
category: aPickupCategoryenum whose name represents the type of pickupname: the name of the item being picked upoffer_id: the Ridwell ID for this particular offerpriority: the pickup priorityproduct_id: the Ridwell ID for this particular productquantity: the amount of the product being picked up
import asyncio
from aioridwell import async_get_client
async def main() -> None:
client = await async_get_client("<EMAIL>", "<PASSWORD>")
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())import asyncio
from aioridwell import async_get_client
async def main() -> None:
client = await async_get_client("<EMAIL>", "<PASSWORD>")
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())Thanks to all of our contributors so far!
- Check for open features/bugs or initiate a discussion on one.
- Fork the repository.
- (optional, but highly recommended) Create a virtual environment:
python3 -m venv .venv - (optional, but highly recommended) Enter the virtual environment:
source ./.venv/bin/activate - Install the dev environment:
script/setup - Code your new feature or bug fix on a new branch.
- Write tests that cover your new functionality.
- Run tests and ensure 100% code coverage:
poetry run pytest --cov aioridwell tests - Update
README.mdwith any new documentation. - Submit a pull request!