معرفی شرکت ها
aiorecollect-2022.10.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
A Python 3, asyncio-based library for the ReCollect Waste API
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | aiorecollect-2022.10.0 |
| نام | aiorecollect |
| نسخه کتابخانه | 2022.10.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Aaron Bach |
| ایمیل نویسنده | bachya1208@gmail.com |
| آدرس صفحه اصلی | https://github.com/bachya/aiorecollect |
| آدرس اینترنتی | https://pypi.org/project/aiorecollect/ |
| مجوز | MIT |
# 🗑 aiorecollect: A Python 3 Library for Pinboard
[](https://github.com/bachya/aiorecollect/actions)
[](https://pypi.python.org/pypi/aiorecollect)
[](https://pypi.python.org/pypi/aiorecollect)
[](https://github.com/bachya/aiorecollect/blob/main/LICENSE)
[](https://codecov.io/gh/bachya/aiorecollect)
[](https://codeclimate.com/github/bachya/aiorecollect/maintainability)
[](https://saythanks.io/to/bachya)
<a href="https://www.buymeacoffee.com/bachya1208P" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
`aiorecollect` is a Python 3, asyncio-based library for the ReCollect Waste API. It
allows users to programmatically retrieve schedules for waste removal in their area,
including trash, recycling, compost, and more.
Special thanks to @stealthhacker for the inspiration!
# Installation
```bash
pip install aiorecollect
```
# Python Versions
`aiorecollect` is currently supported on:
- Python 3.9
- Python 3.10
- Python 3.11
# Place and Service IDs
To use `aiorecollect`, you must know both your ReCollect Place and Service IDs.
In general, cities/municipalities that utilize ReCollect will give you a way to
subscribe to a calendar with pickup dates. If you examine the iCal URL for this
calendar, the Place and Service IDs are embedded in it:
```
webcal://recollect.a.ssl.fastly.net/api/places/PLACE_ID/services/SERVICE_ID/events.en-US.ics
```
# Usage
```python
import asyncio
from datetime import date
from aiorecollect import Client
async def main() -> None:
"""Run."""
client = await Client("<PLACE ID>", "<SERVICE ID>")
# The client has a few attributes that you can access:
client.place_id
client.service_id
# Get all pickup events on the calendar:
pickup_events = await client.async_get_pickup_events()
# ...or get all pickup events within a certain date range:
pickup_events = await client.async_get_pickup_events(
start_date=date(2020, 10, 1), end_date=date(2020, 10, 31)
)
# ...or just get the next pickup event:
next_pickup = await client.async_get_next_pickup_event()
asyncio.run(main())
```
## The `PickupEvent` Object
The `PickupEvent` object that is returned from the above calls comes with three
properties:
- `date`: a `datetime.date` that denotes the pickup date
- `pickup_types`: a list of `PickupType` objects that will occur with this event
- `area_name`: the name of the area in which the event is occurring
## The `PickupType` Object
The `PickupType` object contains the "internal" name of the pickup type _and_ a
human-friendly representation when it exists:
- `name`: the internal name of the pickup type
- `friendly_name`: the humany-friendly name of the pickup type (if it exists)
## Connection Pooling
By default, the library creates a new connection to ReCollect 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`](https://github.com/aio-libs/aiohttp) `ClientSession` can be used for connection
pooling:
```python
import asyncio
from aiohttp import ClientSession
from aiorecollect import Client
async def main() -> None:
"""Run."""
async with ClientSession() as session:
client = await Client("<PLACE ID>", "<SERVICE ID>", session=session)
# Get to work...
asyncio.run(main())
```
# Contributing
1. [Check for open features/bugs](https://github.com/bachya/aiorecollect/issues)
or [initiate a discussion on one](https://github.com/bachya/aiorecollect/issues/new).
2. [Fork the repository](https://github.com/bachya/aiorecollect/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.
7. Write tests that cover your new functionality.
8. Run tests and ensure 100% code coverage: `poetry run pytest --cov aiorecollect tests`
9. Update `README.md` with any new documentation.
10. Add yourself to `AUTHORS.md`.
11. Submit a pull request!
نیازمندی
| مقدار | نام |
|---|---|
| >=3.8.0 | aiohttp |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.9.0,<4.0.0 | Python |
نحوه نصب
نصب پکیج whl aiorecollect-2022.10.0:
pip install aiorecollect-2022.10.0.whl
نصب پکیج tar.gz aiorecollect-2022.10.0:
pip install aiorecollect-2022.10.0.tar.gz