Reference
library to scrape subreddits for images.
- class reddit_photo_aggregator.ImageURLValidator
Image URL validation class to validate image URLs before attempting to download them
- classmethod set_image_extension_whitelist(extension: list[str]) None
Set the image extensions that are allowed to be downloaded
- Parameters:
host (list[str]) – list of image extensions
- classmethod set_image_host_whitelist(host: list[str]) None
Set the domain hosts that are allowed to be downloaded from
- Parameters:
host (list[str]) – list of host domains
- class reddit_photo_aggregator.SubReddit(name: str)
- discover_images(sorted_by='/hot') int
Aggregates images from the subreddit feed
- Parameters:
sorted_by (str, optional) – SortBy value to sort the results by. Defaults to SortBy.hot.
- Returns:
the amount of images found
- Return type:
int
- property loaded_images: list[reddit_photo_aggregator.image.Image]
List of Image loaded when running .discover_images
- Returns:
List of discovered image
- Return type:
list[Image]
- property url: str
The URL of the subreddit based on name
- class reddit_photo_aggregator.Image(url: str)
Image object used to store and load the image content from URL
- property filename: str
the filename that the image will be saved using
- load() None
Retrieves the image content from the URL
- Raises:
ImageRetrieveError – When resource returns any status code other than 200
- save(to: str = './')
Saves the image to disk
- Parameters:
to (str, optional) – Additional path to append to cwd. Defaults to ‘./’.