https://github.com/tyler-tee/roverretriever

Retriever is a lightweight Python wrapper written to facilitate interaction with Dog CEO's API.
https://github.com/tyler-tee/roverretriever

api-client api-rest dogs images pictures pups

Last synced: 5 days ago
JSON representation

Retriever is a lightweight Python wrapper written to facilitate interaction with Dog CEO's API.

• Host: GitHub
• URL: https://github.com/tyler-tee/roverretriever
• Owner: tyler-tee
• License: mit
• Created: 2023-11-23T01:54:12.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2023-11-26T18:01:42.000Z (12 months ago)
• Last Synced: 2024-04-26T23:40:33.265Z (7 months ago)
• Topics: api-client, api-rest, dogs, images, pictures, pups
• Language: Python
• Homepage:
• Size: 8.79 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RoverRetriever: A Python Wrapper for the Dog CEO API

RoverRetriever is a lightweight Python wrapper written to facilitate interaction with [Dog CEO's API](https://dog.ceo/dog-api/).

## Usage

### Initialize the client

```python

from RoverRetriever.rover_retriever import RoverRetriever

dog_api = RoverRetriever()

```

### Get a list of breeds

```python

breeds = dog_api.get_breeds()

```

### Get a random dog image

```python

random_image = dog_api.get_random_image()

```

### Get a number of random dog images by breed

```python

random_image = dog_api.get_random_image(quantity=3, breed='hound')

```

### Get available images by breed

```python

images = dog_api.get_images_by_breed('bulldog')

```

### Get all sub-breeds

```python

sub_breeds = dog_api.get_all_sub_breeds('bulldog')

```