xkcd-wrapper 0.1.0

A wrapper for the xkcd API

xkcd-wrapper

A Python wrapper for the xkcd webcomic API.

Retrieves xkcd comic data and metadata as python objects.

Installation

At the command line, with pip:

$ pip install xkcd-wrapper

Usage

>>> import xkcd_wrapper
>>> client = xkcd_wrapper.Client()
>>> latest_comic = client.get_latest()      # Comic object containing data of the latest xkcd comic
>>> specific_comic = client.get(100)        # Comic object with comic 100 data
>>> random_comic = client.get_random()      # Comic object of a random comic

>>> specific_comic
xkcd_wrapper.Comic(100)
>>> specific_comic.image
'https://imgs.xkcd.com/comics/family_circus.jpg'

Documentation

Check the documentation for more details: https://xkcd-wrapper.readthedocs.io/en/latest

Ideas for the Future

• retrieve comic .jpeg
• async client

History

0.1.0 (23-04-2020)

• First release on PyPI
• Client and Comic classes